Interface ProvisionedProductAttribute.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ProvisionedProductAttribute.Builder,
,ProvisionedProductAttribute> SdkBuilder<ProvisionedProductAttribute.Builder,
,ProvisionedProductAttribute> SdkPojo
- Enclosing class:
ProvisionedProductAttribute
-
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the provisioned product.createdTime
(Instant createdTime) The UTC time stamp of the creation time.The identifier of the provisioned product.idempotencyToken
(String idempotencyToken) A unique identifier that you provide to ensure idempotency.lastProvisioningRecordId
(String lastProvisioningRecordId) The record identifier of the last request performed on this provisioned product of the following types:lastRecordId
(String lastRecordId) The record identifier of the last request performed on this provisioned product.lastSuccessfulProvisioningRecordId
(String lastSuccessfulProvisioningRecordId) The record identifier of the last successful request performed on this provisioned product of the following types:The user-friendly name of the provisioned product.physicalId
(String physicalId) The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.The product identifier.productName
(String productName) The name of the product.provisioningArtifactId
(String provisioningArtifactId) The identifier of the provisioning artifact.provisioningArtifactName
(String provisioningArtifactName) The name of the provisioning artifact.The current status of the provisioned product.status
(ProvisionedProductStatus status) The current status of the provisioned product.statusMessage
(String statusMessage) The current status message of the provisioned product.tags
(Collection<Tag> tags) One or more tags.tags
(Consumer<Tag.Builder>... tags) One or more tags.One or more tags.The type of provisioned product.The Amazon Resource Name (ARN) of the user.userArnSession
(String userArnSession) The ARN of the user in the session.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
name
The user-friendly name of the provisioned product.
- Parameters:
name
- The user-friendly name of the provisioned product.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
arn
The ARN of the provisioned product.
- Parameters:
arn
- The ARN of the provisioned product.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
The type of provisioned product. The supported values are
CFN_STACK
,CFN_STACKSET
,TERRAFORM_OPEN_SOURCE
,TERRAFORM_CLOUD
, andEXTERNAL
.- Parameters:
type
- The type of provisioned product. The supported values areCFN_STACK
,CFN_STACKSET
,TERRAFORM_OPEN_SOURCE
,TERRAFORM_CLOUD
, andEXTERNAL
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
id
The identifier of the provisioned product.
- Parameters:
id
- The identifier of the provisioned product.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 anAVAILABLE
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 anAVAILABLE
status before performing operations.
- Parameters:
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 anAVAILABLE
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 anAVAILABLE
status before performing operations.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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 anAVAILABLE
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 anAVAILABLE
status before performing operations.
- Parameters:
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 anAVAILABLE
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 anAVAILABLE
status before performing operations.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
statusMessage
The current status message of the provisioned product.
- Parameters:
statusMessage
- The current status message of the provisioned product.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdTime
The UTC time stamp of the creation time.
- Parameters:
createdTime
- The UTC time stamp of the creation time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
lastRecordId
The record identifier of the last request performed on this provisioned product.
- Parameters:
lastRecordId
- The record identifier of the last request performed on this provisioned product.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastProvisioningRecordId
The record identifier of the last request performed on this provisioned product of the following types:
-
ProvisionProduct
-
UpdateProvisionedProduct
-
ExecuteProvisionedProductPlan
-
TerminateProvisionedProduct
- Parameters:
lastProvisioningRecordId
- The record identifier of the last request performed on this provisioned product of the following types:-
ProvisionProduct
-
UpdateProvisionedProduct
-
ExecuteProvisionedProductPlan
-
TerminateProvisionedProduct
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
lastSuccessfulProvisioningRecordId
ProvisionedProductAttribute.Builder lastSuccessfulProvisioningRecordId(String lastSuccessfulProvisioningRecordId) The record identifier of the last successful request performed on this provisioned product of the following types:
-
ProvisionProduct
-
UpdateProvisionedProduct
-
ExecuteProvisionedProductPlan
-
TerminateProvisionedProduct
- Parameters:
lastSuccessfulProvisioningRecordId
- The record identifier of the last successful request performed on this provisioned product of the following types:-
ProvisionProduct
-
UpdateProvisionedProduct
-
ExecuteProvisionedProductPlan
-
TerminateProvisionedProduct
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
tags
One or more tags.
- Parameters:
tags
- One or more tags.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
One or more tags.
- Parameters:
tags
- One or more tags.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
One or more tags.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
physicalId
The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.
- Parameters:
physicalId
- The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
productId
The product identifier.
- Parameters:
productId
- The product identifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
productName
The name of the product.
- Parameters:
productName
- The name of the product.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
provisioningArtifactId
The identifier of the provisioning artifact.
- Parameters:
provisioningArtifactId
- The identifier of the provisioning artifact.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
provisioningArtifactName
The name of the provisioning artifact.
- Parameters:
provisioningArtifactName
- The name of the provisioning artifact.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userArn
The Amazon Resource Name (ARN) of the user.
- Parameters:
userArn
- The Amazon Resource Name (ARN) of the user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userArnSession
The ARN of the user in the session. This ARN might contain a session ID.
- Parameters:
userArnSession
- The ARN of the user in the session. This ARN might contain a session ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-