Class ProvisionedProductDetail
- java.lang.Object
-
- software.amazon.awssdk.services.servicecatalog.model.ProvisionedProductDetail
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ProvisionedProductDetail.Builder,ProvisionedProductDetail>
@Generated("software.amazon.awssdk:codegen") public final class ProvisionedProductDetail extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ProvisionedProductDetail.Builder,ProvisionedProductDetail>
Information about a provisioned product.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceProvisionedProductDetail.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()The ARN of the provisioned product.static ProvisionedProductDetail.Builderbuilder()InstantcreatedTime()The UTC time stamp of the creation time.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringid()The identifier of the provisioned product.StringidempotencyToken()A unique identifier that you provide to ensure idempotency.StringlastProvisioningRecordId()The record identifier of the last request performed on this provisioned product of the following types:StringlastRecordId()The record identifier of the last request performed on this provisioned product.StringlastSuccessfulProvisioningRecordId()The record identifier of the last successful request performed on this provisioned product of the following types:StringlaunchRoleArn()The ARN of the launch role associated with the provisioned product.Stringname()The user-friendly name of the provisioned product.StringproductId()The product identifier.StringprovisioningArtifactId()The identifier of the provisioning artifact.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ProvisionedProductDetail.Builder>serializableBuilderClass()ProvisionedProductStatusstatus()The current status of the provisioned product.StringstatusAsString()The current status of the provisioned product.StringstatusMessage()The current status message of the provisioned product.ProvisionedProductDetail.BuildertoBuilder()StringtoString()Returns a string representation of this object.Stringtype()The type of provisioned product.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
name
public final String name()
The user-friendly name of the provisioned product.
- Returns:
- The user-friendly name of the provisioned product.
-
arn
public final String arn()
The ARN of the provisioned product.
- Returns:
- The ARN of the provisioned product.
-
type
public final String type()
The type of provisioned product. The supported values are
CFN_STACK,CFN_STACKSET,TERRAFORM_OPEN_SOURCE,TERRAFORM_CLOUD, andEXTERNAL.- Returns:
- The type of provisioned product. The supported values are
CFN_STACK,CFN_STACKSET,TERRAFORM_OPEN_SOURCE,TERRAFORM_CLOUD, andEXTERNAL.
-
id
public final String id()
The identifier of the provisioned product.
- Returns:
- The identifier of the provisioned product.
-
status
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 anAVAILABLEstatus 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 anAVAILABLEstatus before performing operations.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnProvisionedProductStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- 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 anAVAILABLEstatus 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 anAVAILABLEstatus before performing operations.
-
- See Also:
ProvisionedProductStatus
-
-
statusAsString
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 anAVAILABLEstatus 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 anAVAILABLEstatus before performing operations.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnProvisionedProductStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- 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 anAVAILABLEstatus 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 anAVAILABLEstatus before performing operations.
-
- See Also:
ProvisionedProductStatus
-
-
statusMessage
public final String statusMessage()
The current status message of the provisioned product.
- Returns:
- The current status message of the provisioned product.
-
createdTime
public final Instant createdTime()
The UTC time stamp of the creation time.
- Returns:
- The UTC time stamp of the creation time.
-
idempotencyToken
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.
- Returns:
- 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.
-
lastRecordId
public final String lastRecordId()
The record identifier of the last request performed on this provisioned product.
- Returns:
- The record identifier of the last request performed on this provisioned product.
-
lastProvisioningRecordId
public final String lastProvisioningRecordId()
The record identifier of the last request performed on this provisioned product of the following types:
-
ProvisionProduct
-
UpdateProvisionedProduct
-
ExecuteProvisionedProductPlan
-
TerminateProvisionedProduct
- Returns:
- The record identifier of the last request performed on this provisioned product of the following
types:
-
ProvisionProduct
-
UpdateProvisionedProduct
-
ExecuteProvisionedProductPlan
-
TerminateProvisionedProduct
-
-
-
lastSuccessfulProvisioningRecordId
public final String lastSuccessfulProvisioningRecordId()
The record identifier of the last successful request performed on this provisioned product of the following types:
-
ProvisionProduct
-
UpdateProvisionedProduct
-
ExecuteProvisionedProductPlan
-
TerminateProvisionedProduct
- Returns:
- The record identifier of the last successful request performed on this provisioned product of the
following types:
-
ProvisionProduct
-
UpdateProvisionedProduct
-
ExecuteProvisionedProductPlan
-
TerminateProvisionedProduct
-
-
-
productId
public final String productId()
The product identifier. For example,
prod-abcdzk7xy33qa.- Returns:
- The product identifier. For example,
prod-abcdzk7xy33qa.
-
provisioningArtifactId
public final String provisioningArtifactId()
The identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne.- Returns:
- The identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne.
-
launchRoleArn
public final String launchRoleArn()
The ARN of the launch role associated with the provisioned product.
- Returns:
- The ARN of the launch role associated with the provisioned product.
-
toBuilder
public ProvisionedProductDetail.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ProvisionedProductDetail.Builder,ProvisionedProductDetail>
-
builder
public static ProvisionedProductDetail.Builder builder()
-
serializableBuilderClass
public static Class<? extends ProvisionedProductDetail.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-