Package software.amazon.awssdk.services.cloudformation.model

Interface DescribeChangeSetResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CloudFormationResponse.Builder, CopyableBuilder<DescribeChangeSetResponse.Builder,DescribeChangeSetResponse>, SdkBuilder<DescribeChangeSetResponse.Builder,DescribeChangeSetResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeChangeSetResponse
public static interface DescribeChangeSetResponse.Builder extends CloudFormationResponse.Builder, SdkPojo, CopyableBuilder<DescribeChangeSetResponse.Builder,DescribeChangeSetResponse>

  • Method Details

    • changeSetName

      DescribeChangeSetResponse.Builder changeSetName(String changeSetName)

      The name of the change set.

      Parameters:
      changeSetName - The name of the change set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • changeSetId

      DescribeChangeSetResponse.Builder changeSetId(String changeSetId)

      The Amazon Resource Name (ARN) of the change set.

      Parameters:
      changeSetId - The Amazon Resource Name (ARN) of the change set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stackId

      DescribeChangeSetResponse.Builder stackId(String stackId)

      The Amazon Resource Name (ARN) of the stack that's associated with the change set.

      Parameters:
      stackId - The Amazon Resource Name (ARN) of the stack that's associated with the change set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stackName

      DescribeChangeSetResponse.Builder stackName(String stackName)

      The name of the stack that's associated with the change set.

      Parameters:
      stackName - The name of the stack that's associated with the change set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      DescribeChangeSetResponse.Builder description(String description)

      Information about the change set.

      Parameters:
      description - Information about the change set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      DescribeChangeSetResponse.Builder parameters(Collection<Parameter> parameters)

      A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.

      Parameters:
      parameters - A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      DescribeChangeSetResponse.Builder parameters(Parameter... parameters)

      A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.

      Parameters:
      parameters - A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      DescribeChangeSetResponse.Builder parameters(Consumer<Parameter.Builder>... parameters)

      A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.

      This is a convenience method that creates an instance of the Parameter.Builder avoiding the need to create one manually via Parameter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parameters(List<Parameter>).

      Parameters:
      parameters - a consumer that will call methods on Parameter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • creationTime

      DescribeChangeSetResponse.Builder creationTime(Instant creationTime)

      The start time when the change set was created, in UTC.

      Parameters:
      creationTime - The start time when the change set was created, in UTC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionStatus

      DescribeChangeSetResponse.Builder executionStatus(String executionStatus)

      If the change set execution status is AVAILABLE, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

      Parameters:
      executionStatus - If the change set execution status is AVAILABLE, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • executionStatus

      DescribeChangeSetResponse.Builder executionStatus(ExecutionStatus executionStatus)

      If the change set execution status is AVAILABLE, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

      Parameters:
      executionStatus - If the change set execution status is AVAILABLE, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      DescribeChangeSetResponse.Builder status(String status)

      The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

      Parameters:
      status - The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      DescribeChangeSetResponse.Builder status(ChangeSetStatus status)

      The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

      Parameters:
      status - The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusReason

      DescribeChangeSetResponse.Builder statusReason(String statusReason)

      A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.

      Parameters:
      statusReason - A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notificationARNs

      DescribeChangeSetResponse.Builder notificationARNs(Collection<String> notificationARNs)

      The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.

      Parameters:
      notificationARNs - The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notificationARNs

      DescribeChangeSetResponse.Builder notificationARNs(String... notificationARNs)

      The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.

      Parameters:
      notificationARNs - The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rollbackConfiguration

      DescribeChangeSetResponse.Builder rollbackConfiguration(RollbackConfiguration rollbackConfiguration)

      The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

      Parameters:
      rollbackConfiguration - The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rollbackConfiguration

      default DescribeChangeSetResponse.Builder rollbackConfiguration(Consumer<RollbackConfiguration.Builder> rollbackConfiguration)

      The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

      This is a convenience method that creates an instance of the RollbackConfiguration.Builder avoiding the need to create one manually via RollbackConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rollbackConfiguration(RollbackConfiguration).

      Parameters:
      rollbackConfiguration - a consumer that will call methods on RollbackConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • capabilitiesWithStrings

      DescribeChangeSetResponse.Builder capabilitiesWithStrings(Collection<String> capabilities)

      If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

      Parameters:
      capabilities - If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilitiesWithStrings

      DescribeChangeSetResponse.Builder capabilitiesWithStrings(String... capabilities)

      If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

      Parameters:
      capabilities - If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilities

      DescribeChangeSetResponse.Builder capabilities(Collection<Capability> capabilities)

      If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

      Parameters:
      capabilities - If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilities

      DescribeChangeSetResponse.Builder capabilities(Capability... capabilities)

      If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

      Parameters:
      capabilities - If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      DescribeChangeSetResponse.Builder tags(Collection<Tag> tags)

      If you execute the change set, the tags that will be associated with the stack.

      Parameters:
      tags - If you execute the change set, the tags that will be associated with the stack.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      DescribeChangeSetResponse.Builder tags(Tag... tags)

      If you execute the change set, the tags that will be associated with the stack.

      Parameters:
      tags - If you execute the change set, the tags that will be associated with the stack.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      DescribeChangeSetResponse.Builder tags(Consumer<Tag.Builder>... tags)

      If you execute the change set, the tags that will be associated with the stack.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • changes

      DescribeChangeSetResponse.Builder changes(Collection<Change> changes)

      A list of Change structures that describes the resources CloudFormation changes if you execute the change set.

      Parameters:
      changes - A list of Change structures that describes the resources CloudFormation changes if you execute the change set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • changes

      DescribeChangeSetResponse.Builder changes(Change... changes)

      A list of Change structures that describes the resources CloudFormation changes if you execute the change set.

      Parameters:
      changes - A list of Change structures that describes the resources CloudFormation changes if you execute the change set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • changes

      DescribeChangeSetResponse.Builder changes(Consumer<Change.Builder>... changes)

      A list of Change structures that describes the resources CloudFormation changes if you execute the change set.

      This is a convenience method that creates an instance of the Change.Builder avoiding the need to create one manually via Change.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to changes(List<Change>).

      Parameters:
      changes - a consumer that will call methods on Change.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nextToken

      DescribeChangeSetResponse.Builder nextToken(String nextToken)

      If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.

      Parameters:
      nextToken - If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includeNestedStacks

      DescribeChangeSetResponse.Builder includeNestedStacks(Boolean includeNestedStacks)

      Verifies if IncludeNestedStacks is set to True.

      Parameters:
      includeNestedStacks - Verifies if IncludeNestedStacks is set to True.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parentChangeSetId

      DescribeChangeSetResponse.Builder parentChangeSetId(String parentChangeSetId)

      Specifies the change set ID of the parent change set in the current nested change set hierarchy.

      Parameters:
      parentChangeSetId - Specifies the change set ID of the parent change set in the current nested change set hierarchy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rootChangeSetId

      DescribeChangeSetResponse.Builder rootChangeSetId(String rootChangeSetId)

      Specifies the change set ID of the root change set in the current nested change set hierarchy.

      Parameters:
      rootChangeSetId - Specifies the change set ID of the root change set in the current nested change set hierarchy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • onStackFailure

      DescribeChangeSetResponse.Builder onStackFailure(String onStackFailure)

      Determines what action will be taken if stack creation fails. When this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:

      • DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.

      • DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.

      • ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.

      Parameters:
      onStackFailure - Determines what action will be taken if stack creation fails. When this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:

      • DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.

      • DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.

      • ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.

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

    • onStackFailure

      DescribeChangeSetResponse.Builder onStackFailure(OnStackFailure onStackFailure)

      Determines what action will be taken if stack creation fails. When this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:

      • DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.

      • DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.

      • ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.

      Parameters:
      onStackFailure - Determines what action will be taken if stack creation fails. When this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:

      • DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.

      • DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.

      • ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.

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

    • importExistingResources

      DescribeChangeSetResponse.Builder importExistingResources(Boolean importExistingResources)

      Indicates if the change set imports resources that already exist.

      This parameter can only import resources that have custom names in templates. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead.

      Parameters:
      importExistingResources - Indicates if the change set imports resources that already exist.

      This parameter can only import resources that have custom names in templates. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead.

      Returns:
      Returns a reference to this object so that method calls can be chained together.