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

Interface Stack.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Stack.Builder,Stack>, SdkBuilder<Stack.Builder,Stack>, SdkPojo
Enclosing class:
Stack
public static interface Stack.Builder extends SdkPojo, CopyableBuilder<Stack.Builder,Stack>

  • Method Details

    • stackId

      Stack.Builder stackId(String stackId)

      Unique identifier of the stack.

      Parameters:
      stackId - Unique identifier of the stack.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stackName

      Stack.Builder stackName(String stackName)

      The name associated with the stack.

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

    • changeSetId

      Stack.Builder changeSetId(String changeSetId)

      The unique ID of the change set.

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

    • description

      Stack.Builder description(String description)

      A user-defined description associated with the stack.

      Parameters:
      description - A user-defined description associated with the stack.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      Stack.Builder parameters(Collection<Parameter> parameters)

      A list of Parameter structures.

      Parameters:
      parameters - A list of Parameter structures.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      Stack.Builder parameters(Parameter... parameters)

      A list of Parameter structures.

      Parameters:
      parameters - A list of Parameter structures.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

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

      A list of Parameter structures.

      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

      Stack.Builder creationTime(Instant creationTime)

      The time at which the stack was created.

      Parameters:
      creationTime - The time at which the stack was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deletionTime

      Stack.Builder deletionTime(Instant deletionTime)

      The time the stack was deleted.

      Parameters:
      deletionTime - The time the stack was deleted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdatedTime

      Stack.Builder lastUpdatedTime(Instant lastUpdatedTime)

      The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

      Parameters:
      lastUpdatedTime - The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rollbackConfiguration

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

    • stackStatus

      Stack.Builder stackStatus(String stackStatus)

      Current status of the stack.

      Parameters:
      stackStatus - Current status of the stack.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • stackStatus

      Stack.Builder stackStatus(StackStatus stackStatus)

      Current status of the stack.

      Parameters:
      stackStatus - Current status of the stack.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • stackStatusReason

      Stack.Builder stackStatusReason(String stackStatusReason)

      Success/failure message associated with the stack status.

      Parameters:
      stackStatusReason - Success/failure message associated with the stack status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • disableRollback

      Stack.Builder disableRollback(Boolean disableRollback)

      Boolean to enable or disable rollback on stack creation failures:

      • true: disable rollback.

      • false: enable rollback.

      Parameters:
      disableRollback - Boolean to enable or disable rollback on stack creation failures:

      • true: disable rollback.

      • false: enable rollback.

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

    • notificationARNs

      Stack.Builder notificationARNs(Collection<String> notificationARNs)

      Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.

      Parameters:
      notificationARNs - Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notificationARNs

      Stack.Builder notificationARNs(String... notificationARNs)

      Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.

      Parameters:
      notificationARNs - Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeoutInMinutes

      Stack.Builder timeoutInMinutes(Integer timeoutInMinutes)

      The amount of time within which stack creation should complete.

      Parameters:
      timeoutInMinutes - The amount of time within which stack creation should complete.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilitiesWithStrings

      Stack.Builder capabilitiesWithStrings(Collection<String> capabilities)

      The capabilities allowed in the stack.

      Parameters:
      capabilities - The capabilities allowed in the stack.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilitiesWithStrings

      Stack.Builder capabilitiesWithStrings(String... capabilities)

      The capabilities allowed in the stack.

      Parameters:
      capabilities - The capabilities allowed in the stack.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilities

      Stack.Builder capabilities(Collection<Capability> capabilities)

      The capabilities allowed in the stack.

      Parameters:
      capabilities - The capabilities allowed in the stack.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilities

      Stack.Builder capabilities(Capability... capabilities)

      The capabilities allowed in the stack.

      Parameters:
      capabilities - The capabilities allowed in the stack.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputs

      Stack.Builder outputs(Collection<Output> outputs)

      A list of output structures.

      Parameters:
      outputs - A list of output structures.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputs

      Stack.Builder outputs(Output... outputs)

      A list of output structures.

      Parameters:
      outputs - A list of output structures.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputs

      Stack.Builder outputs(Consumer<Output.Builder>... outputs)

      A list of output structures.

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

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

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

    • roleARN

      Stack.Builder roleARN(String roleARN)

      The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.

      Parameters:
      roleARN - The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      Stack.Builder tags(Collection<Tag> tags)

      A list of Tags that specify information about the stack.

      Parameters:
      tags - A list of Tags that specify information about the stack.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      Stack.Builder tags(Tag... tags)

      A list of Tags that specify information about the stack.

      Parameters:
      tags - A list of Tags that specify information about the stack.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

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

      A list of Tags that specify information about 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:

    • enableTerminationProtection

      Stack.Builder enableTerminationProtection(Boolean enableTerminationProtection)

      Whether termination protection is enabled for the stack.

      For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.

      Parameters:
      enableTerminationProtection - Whether termination protection is enabled for the stack.

      For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.

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

    • parentId

      Stack.Builder parentId(String parentId)

      For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

      For more information, see Working with Nested Stacks in the CloudFormation User Guide.

      Parameters:
      parentId - For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

      For more information, see Working with Nested Stacks in the CloudFormation User Guide.

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

    • rootId

      Stack.Builder rootId(String rootId)

      For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.

      For more information, see Working with Nested Stacks in the CloudFormation User Guide.

      Parameters:
      rootId - For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.

      For more information, see Working with Nested Stacks in the CloudFormation User Guide.

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

    • driftInformation

      Stack.Builder driftInformation(StackDriftInformation driftInformation)

      Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

      Parameters:
      driftInformation - Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • driftInformation

      default Stack.Builder driftInformation(Consumer<StackDriftInformation.Builder> driftInformation)

      Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

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

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

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

    • retainExceptOnCreate

      Stack.Builder retainExceptOnCreate(Boolean retainExceptOnCreate)

      When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

      Default: false

      Parameters:
      retainExceptOnCreate - When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

      Default: false

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

    • detailedStatus

      Stack.Builder detailedStatus(String detailedStatus)

      The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The stack sets CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.

      Parameters:
      detailedStatus - The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The stack sets CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • detailedStatus

      Stack.Builder detailedStatus(DetailedStatus detailedStatus)

      The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The stack sets CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.

      Parameters:
      detailedStatus - The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The stack sets CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: