@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Stack extends Object implements Serializable, Cloneable
The Stack data type.
Constructor and Description |
---|
Stack() |
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.
|
Date |
getDeletionTime()
The time the stack was deleted.
|
String |
getDescription()
A user-defined description associated with the stack.
|
Boolean |
getDisableRollback()
Boolean to enable or disable rollback on stack creation failures:
|
Boolean |
getEnableTerminationProtection()
Whether termination protection is enabled for the stack.
|
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 |
getParentId()
For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this
stack.
|
String |
getRoleARN()
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the
stack.
|
RollbackConfiguration |
getRollbackConfiguration()
The rollback triggers for AWS 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 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.
|
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 |
setDeletionTime(Date deletionTime)
The time the stack was deleted.
|
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 |
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)
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 |
setParentId(String parentId)
For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this
stack.
|
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 |
setRollbackConfiguration(RollbackConfiguration rollbackConfiguration)
The rollback triggers for AWS 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 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; 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 |
withDeletionTime(Date deletionTime)
The time the stack was deleted.
|
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 |
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)
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 |
withParentId(String parentId)
For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this
stack.
|
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 |
withRollbackConfiguration(RollbackConfiguration rollbackConfiguration)
The rollback triggers for AWS 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 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.
|
public void setStackId(String stackId)
Unique identifier of the stack.
stackId
- Unique identifier of the stack.public String getStackId()
Unique identifier of the stack.
public Stack withStackId(String stackId)
Unique identifier of the stack.
stackId
- Unique identifier of the stack.public void setStackName(String stackName)
The name associated with the stack.
stackName
- The name associated with the stack.public String getStackName()
The name associated with the stack.
public Stack withStackName(String stackName)
The name associated with the stack.
stackName
- The name associated with the stack.public void setChangeSetId(String changeSetId)
The unique ID of the change set.
changeSetId
- The unique ID of the change set.public String getChangeSetId()
The unique ID of the change set.
public Stack withChangeSetId(String changeSetId)
The unique ID of the change set.
changeSetId
- The unique ID of the change set.public void setDescription(String description)
A user-defined description associated with the stack.
description
- A user-defined description associated with the stack.public String getDescription()
A user-defined description associated with the stack.
public Stack withDescription(String description)
A user-defined description associated with the stack.
description
- A user-defined description associated with the stack.public List<Parameter> getParameters()
A list of Parameter
structures.
Parameter
structures.public void setParameters(Collection<Parameter> parameters)
A list of Parameter
structures.
parameters
- A list of Parameter
structures.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
- A list of Parameter
structures.public Stack withParameters(Collection<Parameter> parameters)
A list of Parameter
structures.
parameters
- A list of Parameter
structures.public void setCreationTime(Date creationTime)
The time at which the stack was created.
creationTime
- The time at which the stack was created.public Date getCreationTime()
The time at which the stack was created.
public Stack withCreationTime(Date creationTime)
The time at which the stack was created.
creationTime
- The time at which the stack was created.public void setDeletionTime(Date deletionTime)
The time the stack was deleted.
deletionTime
- The time the stack was deleted.public Date getDeletionTime()
The time the stack was deleted.
public Stack withDeletionTime(Date deletionTime)
The time the stack was deleted.
deletionTime
- The time the stack was deleted.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.
lastUpdatedTime
- The time the stack was last updated. This field will only be returned if the stack has been updated at
least once.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.
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.
lastUpdatedTime
- The time the stack was last updated. This field will only be returned if the stack has been updated at
least once.public void setRollbackConfiguration(RollbackConfiguration rollbackConfiguration)
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
rollbackConfiguration
- The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and
for the specified monitoring period afterwards.public RollbackConfiguration getRollbackConfiguration()
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
public Stack withRollbackConfiguration(RollbackConfiguration rollbackConfiguration)
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
rollbackConfiguration
- The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and
for the specified monitoring period afterwards.public void setStackStatus(String stackStatus)
Current status of the stack.
stackStatus
- Current status of the stack.StackStatus
public String getStackStatus()
Current status of the stack.
StackStatus
public Stack withStackStatus(String stackStatus)
Current status of the stack.
stackStatus
- Current status of the stack.StackStatus
public void setStackStatus(StackStatus stackStatus)
Current status of the stack.
stackStatus
- Current status of the stack.StackStatus
public Stack withStackStatus(StackStatus stackStatus)
Current status of the stack.
stackStatus
- Current status of the stack.StackStatus
public void setStackStatusReason(String stackStatusReason)
Success/failure message associated with the stack status.
stackStatusReason
- Success/failure message associated with the stack status.public String getStackStatusReason()
Success/failure message associated with the stack status.
public Stack withStackStatusReason(String stackStatusReason)
Success/failure message associated with the stack status.
stackStatusReason
- Success/failure message associated with the stack status.public void setDisableRollback(Boolean disableRollback)
Boolean to enable or disable rollback on stack creation failures:
true
: disable rollback
false
: enable rollback
disableRollback
- Boolean to enable or disable rollback on stack creation failures:
true
: disable rollback
false
: enable rollback
public Boolean getDisableRollback()
Boolean to enable or disable rollback on stack creation failures:
true
: disable rollback
false
: enable rollback
true
: disable rollback
false
: enable rollback
public Stack withDisableRollback(Boolean disableRollback)
Boolean to enable or disable rollback on stack creation failures:
true
: disable rollback
false
: enable rollback
disableRollback
- Boolean to enable or disable rollback on stack creation failures:
true
: disable rollback
false
: enable rollback
public Boolean isDisableRollback()
Boolean to enable or disable rollback on stack creation failures:
true
: disable rollback
false
: enable rollback
true
: disable rollback
false
: enable rollback
public List<String> getNotificationARNs()
SNS topic ARNs to which stack related events are published.
public void setNotificationARNs(Collection<String> notificationARNs)
SNS topic ARNs to which stack related events are published.
notificationARNs
- SNS topic ARNs to which stack related events are published.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.
notificationARNs
- SNS topic ARNs to which stack related events are published.public Stack withNotificationARNs(Collection<String> notificationARNs)
SNS topic ARNs to which stack related events are published.
notificationARNs
- SNS topic ARNs to which stack related events are published.public void setTimeoutInMinutes(Integer timeoutInMinutes)
The amount of time within which stack creation should complete.
timeoutInMinutes
- The amount of time within which stack creation should complete.public Integer getTimeoutInMinutes()
The amount of time within which stack creation should complete.
public Stack withTimeoutInMinutes(Integer timeoutInMinutes)
The amount of time within which stack creation should complete.
timeoutInMinutes
- The amount of time within which stack creation should complete.public List<String> getCapabilities()
The capabilities allowed in the stack.
Capability
public void setCapabilities(Collection<String> capabilities)
The capabilities allowed in the stack.
capabilities
- The capabilities allowed in the stack.Capability
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.
capabilities
- The capabilities allowed in the stack.Capability
public Stack withCapabilities(Collection<String> capabilities)
The capabilities allowed in the stack.
capabilities
- The capabilities allowed in the stack.Capability
public Stack withCapabilities(Capability... capabilities)
The capabilities allowed in the stack.
capabilities
- The capabilities allowed in the stack.Capability
public List<Output> getOutputs()
A list of output structures.
public void setOutputs(Collection<Output> outputs)
A list of output structures.
outputs
- A list of output structures.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.
outputs
- A list of output structures.public Stack withOutputs(Collection<Output> outputs)
A list of output structures.
outputs
- A list of output structures.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.
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.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.
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.
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.public List<Tag> getTags()
A list of Tag
s that specify information about the stack.
Tag
s that specify information about the stack.public void setTags(Collection<Tag> tags)
A list of Tag
s that specify information about the stack.
tags
- A list of Tag
s that specify information about the stack.public Stack withTags(Tag... tags)
A list of Tag
s 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.
tags
- A list of Tag
s that specify information about the stack.public Stack withTags(Collection<Tag> tags)
A list of Tag
s that specify information about the stack.
tags
- A list of Tag
s that specify information about the stack.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 cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide.
enableTerminationProtection
- Whether termination protection is enabled for the stack.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide.
public Boolean getEnableTerminationProtection()
Whether termination protection is enabled for the stack.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide.
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 cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide.
enableTerminationProtection
- Whether termination protection is enabled for the stack.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide.
public Boolean isEnableTerminationProtection()
Whether termination protection is enabled for the stack.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide.
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 AWS CloudFormation User Guide.
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 AWS CloudFormation User Guide.
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 AWS CloudFormation User Guide.
For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
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 AWS CloudFormation User Guide.
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 AWS CloudFormation User Guide.
public void setRootId(String rootId)
For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs.
For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
rootId
- For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack
to which the nested stack ultimately belongs.
For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
public String getRootId()
For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs.
For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
public Stack withRootId(String rootId)
For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs.
For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
rootId
- For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack
to which the nested stack ultimately belongs.
For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
public String toString()
toString
in class Object
Object.toString()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.