Stack (AWS SDK for Java

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

All Implemented Interfaces:

Serializable, Cloneable
```
public class Stack
extends Object
implements Serializable, Cloneable
```
The Stack data type.

See Also:

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`	`getDescription()` A user-defined description associated with the stack.
`Boolean`	`getDisableRollback()` Boolean to enable or disable rollback on stack creation failures:
`Date`	`getLastUpdatedTime()` The time the stack was last updated.
`List<String>`	`getNotificationARNs()` SNS topic 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`	`getRoleARN()` The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack.
`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:
`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`	`setDescription(String description)` A user-defined description associated with the stack.
`void`	`setDisableRollback(Boolean disableRollback)` Boolean to enable or disable rollback on stack creation failures:
`void`	`setLastUpdatedTime(Date lastUpdatedTime)` The time the stack was last updated.
`void`	`setNotificationARNs(Collection<String> notificationARNs)` SNS topic 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`	`setRoleARN(String roleARN)` The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack.
`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; useful for testing and debugging.
`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`	`withDescription(String description)` A user-defined description associated with the stack.
`Stack`	`withDisableRollback(Boolean disableRollback)` Boolean to enable or disable rollback on stack creation failures:
`Stack`	`withLastUpdatedTime(Date lastUpdatedTime)` The time the stack was last updated.
`Stack`	`withNotificationARNs(Collection<String> notificationARNs)` SNS topic ARNs to which stack related events are published.
`Stack`	`withNotificationARNs(String... notificationARNs)` SNS topic 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`	`withRoleARN(String roleARN)` The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack.
`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.
  - 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.
  - 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()
```
    SNS topic ARNs to which stack related events are published.
    
    Returns:
    
    SNS topic ARNs to which stack related events are published.
  - setNotificationARNs
```
public void setNotificationARNs(Collection<String> notificationARNs)
```
    SNS topic ARNs to which stack related events are published.
    
    Parameters:
    
    notificationARNs - SNS topic ARNs to which stack related events are published.
  - withNotificationARNs
```
public Stack withNotificationARNs(String... notificationARNs)
```
    SNS topic 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 - SNS topic 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)
```
    SNS topic ARNs to which stack related events are published.
    
    Parameters:
    
    notificationARNs - SNS topic 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 AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.
    
    Parameters:
    
    roleARN - The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.
  - getRoleARN
```
public String getRoleARN()
```
    The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.
    
    Returns:
    
    The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS 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 AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.
    
    Parameters:
    
    roleARN - The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS 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.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    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

Did this page help you?

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

setLastUpdatedTime

getLastUpdatedTime

withLastUpdatedTime

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

toString

equals

hashCode

clone