Stack (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudformation.model.Stack

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Stack
extends Object
implements Serializable, Cloneable

The Stack data type.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Stack()

Constructors
Constructor and Description
`Stack()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Stack`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getCapabilities()` The capabilities allowed in the stack.
`String`	`getChangeSetId()` The unique ID of the change set.
`Date`	`getCreationTime()` The time at which the stack was created.
`String`	`getDeletionMode()` Specifies the deletion mode for the stack.
`Date`	`getDeletionTime()` The time the stack was deleted.
`String`	`getDescription()` A user-defined description associated with the stack.
`String`	`getDetailedStatus()` The detailed status of the resource or stack.
`Boolean`	`getDisableRollback()` Boolean to enable or disable rollback on stack creation failures:
`StackDriftInformation`	`getDriftInformation()` 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.
`Boolean`	`getEnableTerminationProtection()` Whether termination protection is enabled for the stack.
`Date`	`getLastUpdatedTime()` The time the stack was last updated.
`List<String>`	`getNotificationARNs()` Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
`List<Output>`	`getOutputs()` A list of output structures.
`List<Parameter>`	`getParameters()` A list of `Parameter` structures.
`String`	`getParentId()` For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack.
`Boolean`	`getRetainExceptOnCreate()` When set to `true`, newly created resources are deleted when the operation rolls back.
`String`	`getRoleARN()` The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack.
`RollbackConfiguration`	`getRollbackConfiguration()` The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
`String`	`getRootId()` 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.
`String`	`getStackId()` Unique identifier of the stack.
`String`	`getStackName()` The name associated with the stack.
`String`	`getStackStatus()` Current status of the stack.
`String`	`getStackStatusReason()` Success/failure message associated with the stack status.
`List<Tag>`	`getTags()` A list of `Tag`s that specify information about the stack.
`Integer`	`getTimeoutInMinutes()` The amount of time within which stack creation should complete.
`int`	`hashCode()`
`Boolean`	`isDisableRollback()` Boolean to enable or disable rollback on stack creation failures:
`Boolean`	`isEnableTerminationProtection()` Whether termination protection is enabled for the stack.
`Boolean`	`isRetainExceptOnCreate()` When set to `true`, newly created resources are deleted when the operation rolls back.
`void`	`setCapabilities(Collection<String> capabilities)` The capabilities allowed in the stack.
`void`	`setChangeSetId(String changeSetId)` The unique ID of the change set.
`void`	`setCreationTime(Date creationTime)` The time at which the stack was created.
`void`	`setDeletionMode(DeletionMode deletionMode)` Specifies the deletion mode for the stack.
`void`	`setDeletionMode(String deletionMode)` Specifies the deletion mode for the stack.
`void`	`setDeletionTime(Date deletionTime)` The time the stack was deleted.
`void`	`setDescription(String description)` A user-defined description associated with the stack.
`void`	`setDetailedStatus(DetailedStatus detailedStatus)` The detailed status of the resource or stack.
`void`	`setDetailedStatus(String detailedStatus)` The detailed status of the resource or stack.
`void`	`setDisableRollback(Boolean disableRollback)` Boolean to enable or disable rollback on stack creation failures:
`void`	`setDriftInformation(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.
`void`	`setEnableTerminationProtection(Boolean enableTerminationProtection)` Whether termination protection is enabled for the stack.
`void`	`setLastUpdatedTime(Date lastUpdatedTime)` The time the stack was last updated.
`void`	`setNotificationARNs(Collection<String> notificationARNs)` Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
`void`	`setOutputs(Collection<Output> outputs)` A list of output structures.
`void`	`setParameters(Collection<Parameter> parameters)` A list of `Parameter` structures.
`void`	`setParentId(String parentId)` For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack.
`void`	`setRetainExceptOnCreate(Boolean retainExceptOnCreate)` When set to `true`, newly created resources are deleted when the operation rolls back.
`void`	`setRoleARN(String roleARN)` The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack.
`void`	`setRollbackConfiguration(RollbackConfiguration rollbackConfiguration)` The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
`void`	`setRootId(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.
`void`	`setStackId(String stackId)` Unique identifier of the stack.
`void`	`setStackName(String stackName)` The name associated with the stack.
`void`	`setStackStatus(StackStatus stackStatus)` Current status of the stack.
`void`	`setStackStatus(String stackStatus)` Current status of the stack.
`void`	`setStackStatusReason(String stackStatusReason)` Success/failure message associated with the stack status.
`void`	`setTags(Collection<Tag> tags)` A list of `Tag`s that specify information about the stack.
`void`	`setTimeoutInMinutes(Integer timeoutInMinutes)` The amount of time within which stack creation should complete.
`String`	`toString()` Returns a string representation of this object.
`Stack`	`withCapabilities(Capability... capabilities)` The capabilities allowed in the stack.
`Stack`	`withCapabilities(Collection<String> capabilities)` The capabilities allowed in the stack.
`Stack`	`withCapabilities(String... capabilities)` The capabilities allowed in the stack.
`Stack`	`withChangeSetId(String changeSetId)` The unique ID of the change set.
`Stack`	`withCreationTime(Date creationTime)` The time at which the stack was created.
`Stack`	`withDeletionMode(DeletionMode deletionMode)` Specifies the deletion mode for the stack.
`Stack`	`withDeletionMode(String deletionMode)` Specifies the deletion mode for the stack.
`Stack`	`withDeletionTime(Date deletionTime)` The time the stack was deleted.
`Stack`	`withDescription(String description)` A user-defined description associated with the stack.
`Stack`	`withDetailedStatus(DetailedStatus detailedStatus)` The detailed status of the resource or stack.
`Stack`	`withDetailedStatus(String detailedStatus)` The detailed status of the resource or stack.
`Stack`	`withDisableRollback(Boolean disableRollback)` Boolean to enable or disable rollback on stack creation failures:
`Stack`	`withDriftInformation(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.
`Stack`	`withEnableTerminationProtection(Boolean enableTerminationProtection)` Whether termination protection is enabled for the stack.
`Stack`	`withLastUpdatedTime(Date lastUpdatedTime)` The time the stack was last updated.
`Stack`	`withNotificationARNs(Collection<String> notificationARNs)` Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
`Stack`	`withNotificationARNs(String... notificationARNs)` Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
`Stack`	`withOutputs(Collection<Output> outputs)` A list of output structures.
`Stack`	`withOutputs(Output... outputs)` A list of output structures.
`Stack`	`withParameters(Collection<Parameter> parameters)` A list of `Parameter` structures.
`Stack`	`withParameters(Parameter... parameters)` A list of `Parameter` structures.
`Stack`	`withParentId(String parentId)` For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack.
`Stack`	`withRetainExceptOnCreate(Boolean retainExceptOnCreate)` When set to `true`, newly created resources are deleted when the operation rolls back.
`Stack`	`withRoleARN(String roleARN)` The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack.
`Stack`	`withRollbackConfiguration(RollbackConfiguration rollbackConfiguration)` The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
`Stack`	`withRootId(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.
`Stack`	`withStackId(String stackId)` Unique identifier of the stack.
`Stack`	`withStackName(String stackName)` The name associated with the stack.
`Stack`	`withStackStatus(StackStatus stackStatus)` Current status of the stack.
`Stack`	`withStackStatus(String stackStatus)` Current status of the stack.
`Stack`	`withStackStatusReason(String stackStatusReason)` Success/failure message associated with the stack status.
`Stack`	`withTags(Collection<Tag> tags)` A list of `Tag`s that specify information about the stack.
`Stack`	`withTags(Tag... tags)` A list of `Tag`s that specify information about the stack.
`Stack`	`withTimeoutInMinutes(Integer timeoutInMinutes)` The amount of time within which stack creation should complete.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Stack
```
public Stack()
```
- Method Detail
  - setStackId
```
public void setStackId(String stackId)
```
    Unique identifier of the stack.
    
    Parameters:
    
    stackId - Unique identifier of the stack.
  - getStackId
```
public String getStackId()
```
    Unique identifier of the stack.
    
    Returns:
    
    Unique identifier of the stack.
  - withStackId
```
public Stack withStackId(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.
  - setStackName
```
public void setStackName(String stackName)
```
    The name associated with the stack.
    
    Parameters:
    
    stackName - The name associated with the stack.
  - getStackName
```
public String getStackName()
```
    The name associated with the stack.
    
    Returns:
    
    The name associated with the stack.
  - withStackName
```
public Stack withStackName(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.
  - setChangeSetId
```
public void setChangeSetId(String changeSetId)
```
    The unique ID of the change set.
    
    Parameters:
    
    changeSetId - The unique ID of the change set.
  - getChangeSetId
```
public String getChangeSetId()
```
    The unique ID of the change set.
    
    Returns:
    
    The unique ID of the change set.
  - withChangeSetId
```
public Stack withChangeSetId(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.
  - setDescription
```
public void setDescription(String description)
```
    A user-defined description associated with the stack.
    
    Parameters:
    
    description - A user-defined description associated with the stack.
  - getDescription
```
public String getDescription()
```
    A user-defined description associated with the stack.
    
    Returns:
    
    A user-defined description associated with the stack.
  - withDescription
```
public Stack withDescription(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.
  - getParameters
```
public List<Parameter> getParameters()
```
    A list of Parameter structures.
    
    Returns:
    
    A list of Parameter structures.
  - setParameters
```
public void setParameters(Collection<Parameter> parameters)
```
    A list of Parameter structures.
    
    Parameters:
    
    parameters - A list of Parameter structures.
  - withParameters
```
public Stack withParameters(Parameter... parameters)
```
    A list of Parameter structures.
    
    NOTE: This method appends the values to the existing list (if any). Use setParameters(java.util.Collection) or withParameters(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    parameters - A list of Parameter structures.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withParameters
```
public Stack withParameters(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.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The time at which the stack was created.
    
    Parameters:
    
    creationTime - The time at which the stack was created.
  - getCreationTime
```
public Date getCreationTime()
```
    The time at which the stack was created.
    
    Returns:
    
    The time at which the stack was created.
  - withCreationTime
```
public Stack withCreationTime(Date 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.
  - setDeletionTime
```
public void setDeletionTime(Date deletionTime)
```
    The time the stack was deleted.
    
    Parameters:
    
    deletionTime - The time the stack was deleted.
  - getDeletionTime
```
public Date getDeletionTime()
```
    The time the stack was deleted.
    
    Returns:
    
    The time the stack was deleted.
  - withDeletionTime
```
public Stack withDeletionTime(Date 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.
  - setLastUpdatedTime
```
public void setLastUpdatedTime(Date 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.
  - getLastUpdatedTime
```
public Date getLastUpdatedTime()
```
    The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
    
    Returns:
    
    The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
  - withLastUpdatedTime
```
public Stack withLastUpdatedTime(Date 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.
  - setRollbackConfiguration
```
public void setRollbackConfiguration(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.
  - getRollbackConfiguration
```
public RollbackConfiguration getRollbackConfiguration()
```
    The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
    
    Returns:
    
    The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
  - withRollbackConfiguration
```
public Stack withRollbackConfiguration(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.
  - setStackStatus
```
public void setStackStatus(String stackStatus)
```
    Current status of the stack.
    
    Parameters:
    
    stackStatus - Current status of the stack.
    
    See Also:
    
    StackStatus
  - getStackStatus
```
public String getStackStatus()
```
    Current status of the stack.
    
    Returns:
    
    Current status of the stack.
    
    See Also:
    
    StackStatus
  - withStackStatus
```
public Stack withStackStatus(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
  - setStackStatus
```
public void setStackStatus(StackStatus stackStatus)
```
    Current status of the stack.
    
    Parameters:
    
    stackStatus - Current status of the stack.
    
    See Also:
    
    StackStatus
  - withStackStatus
```
public Stack withStackStatus(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:
    
    StackStatus
  - setStackStatusReason
```
public void setStackStatusReason(String stackStatusReason)
```
    Success/failure message associated with the stack status.
    
    Parameters:
    
    stackStatusReason - Success/failure message associated with the stack status.
  - getStackStatusReason
```
public String getStackStatusReason()
```
    Success/failure message associated with the stack status.
    
    Returns:
    
    Success/failure message associated with the stack status.
  - withStackStatusReason
```
public Stack withStackStatusReason(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.
  - setDisableRollback
```
public void setDisableRollback(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.
  - getDisableRollback
```
public Boolean getDisableRollback()
```
    Boolean to enable or disable rollback on stack creation failures:
    - true: disable rollback.
    - false: enable rollback.
    Returns:
    Boolean to enable or disable rollback on stack creation failures:
    
    true: disable rollback.
    
    false: enable rollback.
  - withDisableRollback
```
public Stack withDisableRollback(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.
  - isDisableRollback
```
public Boolean isDisableRollback()
```
    Boolean to enable or disable rollback on stack creation failures:
    - true: disable rollback.
    - false: enable rollback.
    Returns:
    Boolean to enable or disable rollback on stack creation failures:
    
    true: disable rollback.
    
    false: enable rollback.
  - getNotificationARNs
```
public List<String> getNotificationARNs()
```
    Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
    
    Returns:
    
    Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
  - setNotificationARNs
```
public void setNotificationARNs(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.
  - withNotificationARNs
```
public Stack withNotificationARNs(String... notificationARNs)
```
    Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
    
    NOTE: This method appends the values to the existing list (if any). Use setNotificationARNs(java.util.Collection) or withNotificationARNs(java.util.Collection) if you want to override the existing values.
    
    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.
  - withNotificationARNs
```
public Stack withNotificationARNs(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.
  - setTimeoutInMinutes
```
public void setTimeoutInMinutes(Integer timeoutInMinutes)
```
    The amount of time within which stack creation should complete.
    
    Parameters:
    
    timeoutInMinutes - The amount of time within which stack creation should complete.
  - getTimeoutInMinutes
```
public Integer getTimeoutInMinutes()
```
    The amount of time within which stack creation should complete.
    
    Returns:
    
    The amount of time within which stack creation should complete.
  - withTimeoutInMinutes
```
public Stack withTimeoutInMinutes(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.
  - getCapabilities
```
public List<String> getCapabilities()
```
    The capabilities allowed in the stack.
    
    Returns:
    
    The capabilities allowed in the stack.
    
    See Also:
    
    Capability
  - setCapabilities
```
public void setCapabilities(Collection<String> capabilities)
```
    The capabilities allowed in the stack.
    
    Parameters:
    
    capabilities - The capabilities allowed in the stack.
    
    See Also:
    
    Capability
  - withCapabilities
```
public Stack withCapabilities(String... capabilities)
```
    The capabilities allowed in the stack.
    
    NOTE: This method appends the values to the existing list (if any). Use setCapabilities(java.util.Collection) or withCapabilities(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    capabilities - The capabilities allowed in the stack.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Capability
  - withCapabilities
```
public Stack withCapabilities(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.
    
    See Also:
    
    Capability
  - withCapabilities
```
public Stack withCapabilities(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.
    
    See Also:
    
    Capability
  - getOutputs
```
public List<Output> getOutputs()
```
    A list of output structures.
    
    Returns:
    
    A list of output structures.
  - setOutputs
```
public void setOutputs(Collection<Output> outputs)
```
    A list of output structures.
    
    Parameters:
    
    outputs - A list of output structures.
  - withOutputs
```
public Stack withOutputs(Output... outputs)
```
    A list of output structures.
    
    NOTE: This method appends the values to the existing list (if any). Use setOutputs(java.util.Collection) or withOutputs(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    outputs - A list of output structures.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withOutputs
```
public Stack withOutputs(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.
  - setRoleARN
```
public void setRoleARN(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.
  - getRoleARN
```
public String getRoleARN()
```
    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:
    
    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.
  - withRoleARN
```
public Stack withRoleARN(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.
  - getTags
```
public List<Tag> getTags()
```
    A list of Tags that specify information about the stack.
    
    Returns:
    
    A list of Tags that specify information about the stack.
  - setTags
```
public void setTags(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.
  - withTags
```
public Stack withTags(Tag... tags)
```
    A list of Tags that specify information about the stack.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    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.
  - withTags
```
public Stack withTags(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.
  - setEnableTerminationProtection
```
public void setEnableTerminationProtection(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.
  - getEnableTerminationProtection
```
public Boolean getEnableTerminationProtection()
```
    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:
    
    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.
  - withEnableTerminationProtection
```
public Stack withEnableTerminationProtection(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.
  - isEnableTerminationProtection
```
public Boolean isEnableTerminationProtection()
```
    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:
    
    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.
  - setParentId
```
public void setParentId(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.
  - getParentId
```
public String getParentId()
```
    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:
    
    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.
  - withParentId
```
public Stack withParentId(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.
  - setRootId
```
public void setRootId(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.
  - getRootId
```
public String getRootId()
```
    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:
    
    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.
  - withRootId
```
public Stack withRootId(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.
  - setDriftInformation
```
public void setDriftInformation(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.
  - getDriftInformation
```
public StackDriftInformation getDriftInformation()
```
    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:
    
    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.
  - withDriftInformation
```
public Stack withDriftInformation(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.
  - setRetainExceptOnCreate
```
public void setRetainExceptOnCreate(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
  - getRetainExceptOnCreate
```
public Boolean getRetainExceptOnCreate()
```
    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:
    
    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
  - withRetainExceptOnCreate
```
public Stack withRetainExceptOnCreate(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.
  - isRetainExceptOnCreate
```
public Boolean isRetainExceptOnCreate()
```
    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:
    
    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
  - setDeletionMode
```
public void setDeletionMode(String deletionMode)
```
    Specifies the deletion mode for the stack. Possible values are:
    - STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.
    - FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.
    Parameters:
    deletionMode - Specifies the deletion mode for the stack. Possible values are:
    
    STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.
    
    FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.
    See Also:
    
    DeletionMode
  - getDeletionMode
```
public String getDeletionMode()
```
    Specifies the deletion mode for the stack. Possible values are:
    - STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.
    - FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.
    Returns:
    Specifies the deletion mode for the stack. Possible values are:
    
    STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.
    
    FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.
    See Also:
    
    DeletionMode
  - withDeletionMode
```
public Stack withDeletionMode(String deletionMode)
```
    Specifies the deletion mode for the stack. Possible values are:
    - STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.
    - FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.
    Parameters:
    deletionMode - Specifies the deletion mode for the stack. Possible values are:
    
    STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.
    
    FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeletionMode
  - setDeletionMode
```
public void setDeletionMode(DeletionMode deletionMode)
```
    Specifies the deletion mode for the stack. Possible values are:
    - STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.
    - FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.
    Parameters:
    deletionMode - Specifies the deletion mode for the stack. Possible values are:
    
    STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.
    
    FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.
    See Also:
    
    DeletionMode
  - withDeletionMode
```
public Stack withDeletionMode(DeletionMode deletionMode)
```
    Specifies the deletion mode for the stack. Possible values are:
    - STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.
    - FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.
    Parameters:
    deletionMode - Specifies the deletion mode for the stack. Possible values are:
    
    STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.
    
    FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeletionMode
  - setDetailedStatus
```
public void setDetailedStatus(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.
    
    See Also:
    
    DetailedStatus
  - getDetailedStatus
```
public String getDetailedStatus()
```
    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:
    
    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.
    
    See Also:
    
    DetailedStatus
  - withDetailedStatus
```
public Stack withDetailedStatus(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
  - setDetailedStatus
```
public void setDetailedStatus(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.
    
    See Also:
    
    DetailedStatus
  - withDetailedStatus
```
public Stack withDetailedStatus(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:
    
    DetailedStatus
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Stack clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.773

Class Stack

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Stack

Method Detail

setStackId

getStackId

withStackId

setStackName

getStackName

withStackName

setChangeSetId

getChangeSetId

withChangeSetId

setDescription

getDescription

withDescription

getParameters

setParameters

withParameters

withParameters

setCreationTime

getCreationTime

withCreationTime

setDeletionTime

getDeletionTime

withDeletionTime

setLastUpdatedTime

getLastUpdatedTime

withLastUpdatedTime

setRollbackConfiguration

getRollbackConfiguration

withRollbackConfiguration

setStackStatus

getStackStatus

withStackStatus

setStackStatus

withStackStatus

setStackStatusReason

getStackStatusReason

withStackStatusReason

setDisableRollback

getDisableRollback

withDisableRollback

isDisableRollback

getNotificationARNs

setNotificationARNs

withNotificationARNs

withNotificationARNs

setTimeoutInMinutes

getTimeoutInMinutes

withTimeoutInMinutes

getCapabilities

setCapabilities

withCapabilities

withCapabilities

withCapabilities

getOutputs

setOutputs

withOutputs

withOutputs

setRoleARN

getRoleARN

withRoleARN

getTags

setTags

withTags

withTags

setEnableTerminationProtection

getEnableTerminationProtection

withEnableTerminationProtection

isEnableTerminationProtection

setParentId

getParentId

withParentId

setRootId

getRootId