Interface ProvisionedProductDetail.Builder

    • Method Detail

      • name

        ProvisionedProductDetail.Builder name​(String 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

        ProvisionedProductDetail.Builder arn​(String 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

        ProvisionedProductDetail.Builder type​(String type)

        The type of provisioned product. The supported values are CFN_STACK, CFN_STACKSET, TERRAFORM_OPEN_SOURCE, TERRAFORM_CLOUD, and EXTERNAL.

        Parameters:
        type - The type of provisioned product. The supported values are CFN_STACK, CFN_STACKSET, TERRAFORM_OPEN_SOURCE, TERRAFORM_CLOUD, and EXTERNAL.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • id

        ProvisionedProductDetail.Builder id​(String 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

        ProvisionedProductDetail.Builder status​(String 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.

        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 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ProvisionedProductStatus, ProvisionedProductStatus
      • status

        ProvisionedProductDetail.Builder status​(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.

        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 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ProvisionedProductStatus, ProvisionedProductStatus
      • statusMessage

        ProvisionedProductDetail.Builder statusMessage​(String 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

        ProvisionedProductDetail.Builder createdTime​(Instant 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

        ProvisionedProductDetail.Builder idempotencyToken​(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.

        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

        ProvisionedProductDetail.Builder lastRecordId​(String 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

        ProvisionedProductDetail.Builder lastProvisioningRecordId​(String 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

        ProvisionedProductDetail.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.
      • productId

        ProvisionedProductDetail.Builder productId​(String productId)

        The product identifier. For example, prod-abcdzk7xy33qa.

        Parameters:
        productId - The product identifier. For example, prod-abcdzk7xy33qa.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • provisioningArtifactId

        ProvisionedProductDetail.Builder provisioningArtifactId​(String provisioningArtifactId)

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

        Parameters:
        provisioningArtifactId - The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • launchRoleArn

        ProvisionedProductDetail.Builder launchRoleArn​(String launchRoleArn)

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

        Parameters:
        launchRoleArn - The ARN of the launch role associated with the provisioned product.
        Returns:
        Returns a reference to this object so that method calls can be chained together.