Documentation

Information about a provisioned product.

See: newProvisionedProductDetail smart constructor.

Create a value of ProvisionedProductDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:launchRoleArn:ProvisionedProductDetail', provisionedProductDetail_launchRoleArn - The ARN of the launch role associated with the provisioned product.

$sel:idempotencyToken:ProvisionedProductDetail', provisionedProductDetail_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.

$sel:status:ProvisionedProductDetail', provisionedProductDetail_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.

$sel:lastSuccessfulProvisioningRecordId:ProvisionedProductDetail', provisionedProductDetail_lastSuccessfulProvisioningRecordId - The record identifier of the last successful request performed on this provisioned product of the following types:

• ProvisionedProduct
• UpdateProvisionedProduct
• ExecuteProvisionedProductPlan
• TerminateProvisionedProduct

$sel:provisioningArtifactId:ProvisionedProductDetail', provisionedProductDetail_provisioningArtifactId - The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

$sel:arn:ProvisionedProductDetail', provisionedProductDetail_arn - The ARN of the provisioned product.

$sel:createdTime:ProvisionedProductDetail', provisionedProductDetail_createdTime - The UTC time stamp of the creation time.

$sel:statusMessage:ProvisionedProductDetail', provisionedProductDetail_statusMessage - The current status message of the provisioned product.

$sel:name:ProvisionedProductDetail', provisionedProductDetail_name - The user-friendly name of the provisioned product.

$sel:lastRecordId:ProvisionedProductDetail', provisionedProductDetail_lastRecordId - The record identifier of the last request performed on this provisioned product.

$sel:id:ProvisionedProductDetail', provisionedProductDetail_id - The identifier of the provisioned product.

$sel:type':ProvisionedProductDetail', provisionedProductDetail_type - The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

$sel:lastProvisioningRecordId:ProvisionedProductDetail', provisionedProductDetail_lastProvisioningRecordId - The record identifier of the last request performed on this provisioned product of the following types:

• ProvisionedProduct
• UpdateProvisionedProduct
• ExecuteProvisionedProductPlan
• TerminateProvisionedProduct

$sel:productId:ProvisionedProductDetail', provisionedProductDetail_productId - The product identifier. For example, prod-abcdzk7xy33qa.

The ARN of the launch role associated with the provisioned product.

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.

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.

The record identifier of the last successful request performed on this provisioned product of the following types:

• ProvisionedProduct
• UpdateProvisionedProduct
• ExecuteProvisionedProductPlan
• TerminateProvisionedProduct

The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

The ARN of the provisioned product.

The UTC time stamp of the creation time.

The current status message of the provisioned product.

The user-friendly name of the provisioned product.

The record identifier of the last request performed on this provisioned product.

The identifier of the provisioned product.

The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

The record identifier of the last request performed on this provisioned product of the following types:

• ProvisionedProduct
• UpdateProvisionedProduct
• ExecuteProvisionedProductPlan
• TerminateProvisionedProduct

The product identifier. For example, prod-abcdzk7xy33qa.