@Generated(value="software.amazon.awssdk:codegen") public final class ProvisionedProductAttribute extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ProvisionedProductAttribute.Builder,ProvisionedProductAttribute>
Information about a provisioned product.
Modifier and Type | Class and Description |
---|---|
static interface |
ProvisionedProductAttribute.Builder |
Modifier and Type | Method and Description |
---|---|
String |
arn()
The ARN of the provisioned product.
|
static ProvisionedProductAttribute.Builder |
builder() |
Instant |
createdTime()
The UTC time stamp of the creation time.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
String |
id()
The identifier of the provisioned product.
|
String |
idempotencyToken()
A unique identifier that you provide to ensure idempotency.
|
String |
lastProvisioningRecordId()
The record identifier of the last request performed on this provisioned product of the following types:
|
String |
lastRecordId()
The record identifier of the last request performed on this provisioned product.
|
String |
lastSuccessfulProvisioningRecordId()
The record identifier of the last successful request performed on this provisioned product of the following
types:
|
String |
name()
The user-friendly name of the provisioned product.
|
String |
physicalId()
The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.
|
String |
productId()
The product identifier.
|
String |
productName()
The name of the product.
|
String |
provisioningArtifactId()
The identifier of the provisioning artifact.
|
String |
provisioningArtifactName()
The name of the provisioning artifact.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ProvisionedProductAttribute.Builder> |
serializableBuilderClass() |
ProvisionedProductStatus |
status()
The current status of the provisioned product.
|
String |
statusAsString()
The current status of the provisioned product.
|
String |
statusMessage()
The current status message of the provisioned product.
|
List<Tag> |
tags()
One or more tags.
|
ProvisionedProductAttribute.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
String |
type()
The type of provisioned product.
|
String |
userArn()
The Amazon Resource Name (ARN) of the IAM user.
|
String |
userArnSession()
The ARN of the IAM user in the session.
|
copy
public final String name()
The user-friendly name of the provisioned product.
public final String arn()
The ARN of the provisioned product.
public final String type()
The type of provisioned product. The supported values are CFN_STACK
and CFN_STACKSET
.
CFN_STACK
and
CFN_STACKSET
.public final String id()
The identifier of the provisioned product.
public final ProvisionedProductStatus status()
The current status of the provisioned product.
AVAILABLE
- Stable state, ready to perform any operation. The most recent operation succeeded and
completed.
UNDER_CHANGE
- Transitive state. Operations performed might not have valid results. Wait for an
AVAILABLE
status before performing operations.
TAINTED
- Stable state, ready to perform any operation. The stack has completed the requested
operation but is not exactly what was requested. For example, a request to update to a new version failed and the
stack rolled back to the current version.
ERROR
- An unexpected error occurred. The provisioned product exists but the stack is not running.
For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
PLAN_IN_PROGRESS
- Transitive state. The plan operations were performed to provision a new product,
but resources have not yet been created. After reviewing the list of resources to be created, execute the plan.
Wait for an AVAILABLE
status before performing operations.
If the service returns an enum value that is not available in the current SDK version, status
will
return ProvisionedProductStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from statusAsString()
.
AVAILABLE
- Stable state, ready to perform any operation. The most recent operation
succeeded and completed.
UNDER_CHANGE
- Transitive state. Operations performed might not have valid results. Wait for
an AVAILABLE
status before performing operations.
TAINTED
- Stable state, ready to perform any operation. The stack has completed the
requested operation but is not exactly what was requested. For example, a request to update to a new
version failed and the stack rolled back to the current version.
ERROR
- An unexpected error occurred. The provisioned product exists but the stack is not
running. For example, CloudFormation received a parameter value that was not valid and could not launch
the stack.
PLAN_IN_PROGRESS
- Transitive state. The plan operations were performed to provision a new
product, but resources have not yet been created. After reviewing the list of resources to be created,
execute the plan. Wait for an AVAILABLE
status before performing operations.
ProvisionedProductStatus
public final String statusAsString()
The current status of the provisioned product.
AVAILABLE
- Stable state, ready to perform any operation. The most recent operation succeeded and
completed.
UNDER_CHANGE
- Transitive state. Operations performed might not have valid results. Wait for an
AVAILABLE
status before performing operations.
TAINTED
- Stable state, ready to perform any operation. The stack has completed the requested
operation but is not exactly what was requested. For example, a request to update to a new version failed and the
stack rolled back to the current version.
ERROR
- An unexpected error occurred. The provisioned product exists but the stack is not running.
For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
PLAN_IN_PROGRESS
- Transitive state. The plan operations were performed to provision a new product,
but resources have not yet been created. After reviewing the list of resources to be created, execute the plan.
Wait for an AVAILABLE
status before performing operations.
If the service returns an enum value that is not available in the current SDK version, status
will
return ProvisionedProductStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from statusAsString()
.
AVAILABLE
- Stable state, ready to perform any operation. The most recent operation
succeeded and completed.
UNDER_CHANGE
- Transitive state. Operations performed might not have valid results. Wait for
an AVAILABLE
status before performing operations.
TAINTED
- Stable state, ready to perform any operation. The stack has completed the
requested operation but is not exactly what was requested. For example, a request to update to a new
version failed and the stack rolled back to the current version.
ERROR
- An unexpected error occurred. The provisioned product exists but the stack is not
running. For example, CloudFormation received a parameter value that was not valid and could not launch
the stack.
PLAN_IN_PROGRESS
- Transitive state. The plan operations were performed to provision a new
product, but resources have not yet been created. After reviewing the list of resources to be created,
execute the plan. Wait for an AVAILABLE
status before performing operations.
ProvisionedProductStatus
public final String statusMessage()
The current status message of the provisioned product.
public final Instant createdTime()
The UTC time stamp of the creation time.
public final String idempotencyToken()
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
public final String lastRecordId()
The record identifier of the last request performed on this provisioned product.
public final String lastProvisioningRecordId()
The record identifier of the last request performed on this provisioned product of the following types:
ProvisionedProduct
UpdateProvisionedProduct
ExecuteProvisionedProductPlan
TerminateProvisionedProduct
ProvisionedProduct
UpdateProvisionedProduct
ExecuteProvisionedProductPlan
TerminateProvisionedProduct
public final String lastSuccessfulProvisioningRecordId()
The record identifier of the last successful request performed on this provisioned product of the following types:
ProvisionedProduct
UpdateProvisionedProduct
ExecuteProvisionedProductPlan
TerminateProvisionedProduct
ProvisionedProduct
UpdateProvisionedProduct
ExecuteProvisionedProductPlan
TerminateProvisionedProduct
public final boolean hasTags()
public final List<Tag> tags()
One or more tags.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTags()
to see if a value was sent in this field.
public final String physicalId()
The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.
public final String productId()
The product identifier.
public final String productName()
The name of the product.
public final String provisioningArtifactId()
The identifier of the provisioning artifact.
public final String provisioningArtifactName()
The name of the provisioning artifact.
public final String userArn()
The Amazon Resource Name (ARN) of the IAM user.
public final String userArnSession()
The ARN of the IAM user in the session. This ARN might contain a session ID.
public ProvisionedProductAttribute.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ProvisionedProductAttribute.Builder,ProvisionedProductAttribute>
public static ProvisionedProductAttribute.Builder builder()
public static Class<? extends ProvisionedProductAttribute.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.