Stack (AWS SDK For Java for OSGi 1.10.21 API)

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

Methods
Modifier and Type	Method and Description
`Stack`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getCapabilities()` The capabilities allowed in the stack.
`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`	`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 cost allocation information for 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`	`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`	`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 cost allocation information for 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`	`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`	`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 cost allocation information for the stack.
`Stack`	`withTags(Tag... tags)` A list of `Tag`s that specify cost allocation information for the stack.
`Stack`	`withTimeoutInMinutes(Integer timeoutInMinutes)` The amount of time within which stack creation should complete.

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

- Constructor Detail
  - Stack
```
public Stack()
```
- Method Detail
  - getStackId
```
public String getStackId()
```
    Unique identifier of the stack.
    
    Returns:
    Unique identifier of the stack.
  - setStackId
```
public void setStackId(String stackId)
```
    Unique identifier of the stack.
    
    Parameters:
    stackId - Unique identifier of the stack.
  - withStackId
```
public Stack withStackId(String stackId)
```
    Unique identifier of the stack.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    stackId - Unique identifier of the stack.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getStackName
```
public String getStackName()
```
    The name associated with the stack.
    
    Returns:
    The name associated with the stack.
  - setStackName
```
public void setStackName(String stackName)
```
    The name associated with the stack.
    
    Parameters:
    stackName - The name associated with the stack.
  - withStackName
```
public Stack withStackName(String stackName)
```
    The name associated with the stack.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    stackName - The name associated with the stack.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDescription
```
public String getDescription()
```
    A user-defined description associated with the stack.
    
    Returns:
    A user-defined description associated with the stack.
  - setDescription
```
public void setDescription(String description)
```
    A user-defined description associated with the stack.
    
    Parameters:
    description - A user-defined description associated with the stack.
  - withDescription
```
public Stack withDescription(String description)
```
    A user-defined description associated with the stack.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    description - A user-defined description associated with the stack.
    
    Returns:
    A reference to this updated 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.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    parameters - A list of Parameter structures.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withParameters
```
public Stack withParameters(Collection<Parameter> parameters)
```
    A list of Parameter structures.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    parameters - A list of Parameter structures.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getCreationTime
```
public Date getCreationTime()
```
    The time at which the stack was created.
    
    Returns:
    The time at which the stack was created.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The time at which the stack was created.
    
    Parameters:
    creationTime - The time at which the stack was created.
  - withCreationTime
```
public Stack withCreationTime(Date creationTime)
```
    The time at which the stack was created.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    creationTime - The time at which the stack was created.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    A reference to this updated object so that method calls can be chained together.
  - getStackStatus
```
public String getStackStatus()
```
    Current status of the stack.
    Constraints:
    Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE
    
    Returns:
    Current status of the stack.
    See Also:
    StackStatus
  - setStackStatus
```
public void setStackStatus(String stackStatus)
```
    Current status of the stack.
    Constraints:
    Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE
    
    Parameters:
    stackStatus - Current status of the stack.
    See Also:
    StackStatus
  - withStackStatus
```
public Stack withStackStatus(String stackStatus)
```
    Current status of the stack.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE
    
    Parameters:
    stackStatus - Current status of the stack.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    StackStatus
  - setStackStatus
```
public void setStackStatus(StackStatus stackStatus)
```
    Current status of the stack.
    Constraints:
    Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE
    
    Parameters:
    stackStatus - Current status of the stack.
    See Also:
    StackStatus
  - withStackStatus
```
public Stack withStackStatus(StackStatus stackStatus)
```
    Current status of the stack.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE
    
    Parameters:
    stackStatus - Current status of the stack.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    StackStatus
  - getStackStatusReason
```
public String getStackStatusReason()
```
    Success/failure message associated with the stack status.
    
    Returns:
    Success/failure message associated with the stack status.
  - setStackStatusReason
```
public void setStackStatusReason(String stackStatusReason)
```
    Success/failure message associated with the stack status.
    
    Parameters:
    stackStatusReason - Success/failure message associated with the stack status.
  - withStackStatusReason
```
public Stack withStackStatusReason(String stackStatusReason)
```
    Success/failure message associated with the stack status.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    stackStatusReason - Success/failure message associated with the stack status.
    
    Returns:
    A reference to this updated 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
  - 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
  - withDisableRollback
```
public Stack withDisableRollback(Boolean disableRollback)
```
    Boolean to enable or disable rollback on stack creation failures:
    - true: disable rollback
    - false: enable rollback
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    disableRollback - Boolean to enable or disable rollback on stack creation failures:
    
    true: disable rollback
    
    false: enable rollback
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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
  - getNotificationARNs
```
public List<String> getNotificationARNs()
```
    SNS topic ARNs to which stack related events are published.
    Constraints:
    Length: 0 - 5
    
    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.
    Constraints:
    Length: 0 - 5
    
    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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 5
    
    Parameters:
    notificationARNs - SNS topic ARNs to which stack related events are published.
    
    Returns:
    A reference to this updated 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 5
    
    Parameters:
    notificationARNs - SNS topic ARNs to which stack related events are published.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getTimeoutInMinutes
```
public Integer getTimeoutInMinutes()
```
    The amount of time within which stack creation should complete.
    Constraints:
    Range: 1 -
    
    Returns:
    The amount of time within which stack creation should complete.
  - setTimeoutInMinutes
```
public void setTimeoutInMinutes(Integer timeoutInMinutes)
```
    The amount of time within which stack creation should complete.
    Constraints:
    Range: 1 -
    
    Parameters:
    timeoutInMinutes - 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 -
    
    Parameters:
    timeoutInMinutes - The amount of time within which stack creation should complete.
    
    Returns:
    A reference to this updated 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.
  - setCapabilities
```
public void setCapabilities(Collection<String> capabilities)
```
    The capabilities allowed in the stack.
    
    Parameters:
    capabilities - The capabilities allowed in the stack.
  - 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.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    capabilities - The capabilities allowed in the stack.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withCapabilities
```
public Stack withCapabilities(Collection<String> capabilities)
```
    The capabilities allowed in the stack.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    capabilities - The capabilities allowed in the stack.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withCapabilities
```
public Stack withCapabilities(Capability... capabilities)
```
    The capabilities allowed in the stack.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    capabilities - The capabilities allowed in the stack.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    outputs - A list of output structures.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withOutputs
```
public Stack withOutputs(Collection<Output> outputs)
```
    A list of output structures.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    outputs - A list of output structures.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    A list of Tags that specify cost allocation information for the stack.
    
    Returns:
    A list of Tags that specify cost allocation information for the stack.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    A list of Tags that specify cost allocation information for the stack.
    
    Parameters:
    tags - A list of Tags that specify cost allocation information for the stack.
  - withTags
```
public Stack withTags(Tag... tags)
```
    A list of Tags that specify cost allocation information for 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.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    tags - A list of Tags that specify cost allocation information for the stack.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withTags
```
public Stack withTags(Collection<Tag> tags)
```
    A list of Tags that specify cost allocation information for the stack.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    tags - A list of Tags that specify cost allocation information for the stack.
    
    Returns:
    A reference to this updated 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()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - clone
```
public Stack clone()
```
    Overrides:
    
    clone in class Object

Class Stack

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Stack

Method Detail

getStackId

setStackId

withStackId

getStackName

setStackName

withStackName

getDescription

setDescription

withDescription

getParameters

setParameters

withParameters

withParameters

getCreationTime

setCreationTime

withCreationTime

getLastUpdatedTime

setLastUpdatedTime

withLastUpdatedTime

getStackStatus

setStackStatus

withStackStatus

setStackStatus

withStackStatus

getStackStatusReason

setStackStatusReason

withStackStatusReason

isDisableRollback

setDisableRollback

withDisableRollback

getDisableRollback

getNotificationARNs

setNotificationARNs

withNotificationARNs

withNotificationARNs

getTimeoutInMinutes

setTimeoutInMinutes

withTimeoutInMinutes

getCapabilities

setCapabilities

withCapabilities

withCapabilities

withCapabilities

getOutputs

setOutputs

withOutputs

withOutputs

getTags

setTags

withTags

withTags

toString

hashCode

equals

clone