Class DescribeChangeSetResult
- java.lang.Object
-
- com.amazonaws.services.cloudformation.model.DescribeChangeSetResult
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class DescribeChangeSetResult extends Object implements Serializable, Cloneable
The output for the DescribeChangeSet action.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DescribeChangeSetResult()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescribeChangeSetResult
clone()
boolean
equals(Object obj)
List<String>
getCapabilities()
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.List<Change>
getChanges()
A list ofChange
structures that describes the resources AWS CloudFormation changes if you execute the change set.String
getChangeSetId()
The ARN of the change set.String
getChangeSetName()
The name of the change set.Date
getCreationTime()
The start time when the change set was created, in UTC.String
getDescription()
Information about the change set.String
getExecutionStatus()
If the change set execution status isAVAILABLE
, you can execute the change set.String
getNextToken()
If the output exceeds 1 MB, a string that identifies the next page of changes.List<String>
getNotificationARNs()
The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.List<Parameter>
getParameters()
A list ofParameter
structures that describes the input parameters and their values used to create the change set.String
getStackId()
The ARN of the stack that is associated with the change set.String
getStackName()
The name of the stack that is associated with the change set.String
getStatus()
The current status of the change set, such asCREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.String
getStatusReason()
A description of the change set's status.List<Tag>
getTags()
If you execute the change set, the tags that will be associated with the stack.int
hashCode()
void
setCapabilities(Collection<String> capabilities)
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.void
setChanges(Collection<Change> changes)
A list ofChange
structures that describes the resources AWS CloudFormation changes if you execute the change set.void
setChangeSetId(String changeSetId)
The ARN of the change set.void
setChangeSetName(String changeSetName)
The name of the change set.void
setCreationTime(Date creationTime)
The start time when the change set was created, in UTC.void
setDescription(String description)
Information about the change set.void
setExecutionStatus(ExecutionStatus executionStatus)
If the change set execution status isAVAILABLE
, you can execute the change set.void
setExecutionStatus(String executionStatus)
If the change set execution status isAVAILABLE
, you can execute the change set.void
setNextToken(String nextToken)
If the output exceeds 1 MB, a string that identifies the next page of changes.void
setNotificationARNs(Collection<String> notificationARNs)
The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.void
setParameters(Collection<Parameter> parameters)
A list ofParameter
structures that describes the input parameters and their values used to create the change set.void
setStackId(String stackId)
The ARN of the stack that is associated with the change set.void
setStackName(String stackName)
The name of the stack that is associated with the change set.void
setStatus(ChangeSetStatus status)
The current status of the change set, such asCREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.void
setStatus(String status)
The current status of the change set, such asCREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.void
setStatusReason(String statusReason)
A description of the change set's status.void
setTags(Collection<Tag> tags)
If you execute the change set, the tags that will be associated with the stack.String
toString()
Returns a string representation of this object; useful for testing and debugging.DescribeChangeSetResult
withCapabilities(Capability... capabilities)
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.DescribeChangeSetResult
withCapabilities(String... capabilities)
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.DescribeChangeSetResult
withCapabilities(Collection<String> capabilities)
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.DescribeChangeSetResult
withChanges(Change... changes)
A list ofChange
structures that describes the resources AWS CloudFormation changes if you execute the change set.DescribeChangeSetResult
withChanges(Collection<Change> changes)
A list ofChange
structures that describes the resources AWS CloudFormation changes if you execute the change set.DescribeChangeSetResult
withChangeSetId(String changeSetId)
The ARN of the change set.DescribeChangeSetResult
withChangeSetName(String changeSetName)
The name of the change set.DescribeChangeSetResult
withCreationTime(Date creationTime)
The start time when the change set was created, in UTC.DescribeChangeSetResult
withDescription(String description)
Information about the change set.DescribeChangeSetResult
withExecutionStatus(ExecutionStatus executionStatus)
If the change set execution status isAVAILABLE
, you can execute the change set.DescribeChangeSetResult
withExecutionStatus(String executionStatus)
If the change set execution status isAVAILABLE
, you can execute the change set.DescribeChangeSetResult
withNextToken(String nextToken)
If the output exceeds 1 MB, a string that identifies the next page of changes.DescribeChangeSetResult
withNotificationARNs(String... notificationARNs)
The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.DescribeChangeSetResult
withNotificationARNs(Collection<String> notificationARNs)
The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.DescribeChangeSetResult
withParameters(Parameter... parameters)
A list ofParameter
structures that describes the input parameters and their values used to create the change set.DescribeChangeSetResult
withParameters(Collection<Parameter> parameters)
A list ofParameter
structures that describes the input parameters and their values used to create the change set.DescribeChangeSetResult
withStackId(String stackId)
The ARN of the stack that is associated with the change set.DescribeChangeSetResult
withStackName(String stackName)
The name of the stack that is associated with the change set.DescribeChangeSetResult
withStatus(ChangeSetStatus status)
The current status of the change set, such asCREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.DescribeChangeSetResult
withStatus(String status)
The current status of the change set, such asCREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.DescribeChangeSetResult
withStatusReason(String statusReason)
A description of the change set's status.DescribeChangeSetResult
withTags(Tag... tags)
If you execute the change set, the tags that will be associated with the stack.DescribeChangeSetResult
withTags(Collection<Tag> tags)
If you execute the change set, the tags that will be associated with the stack.
-
-
-
Method Detail
-
setChangeSetName
public void setChangeSetName(String changeSetName)
The name of the change set.
- Parameters:
changeSetName
- The name of the change set.
-
getChangeSetName
public String getChangeSetName()
The name of the change set.
- Returns:
- The name of the change set.
-
withChangeSetName
public DescribeChangeSetResult withChangeSetName(String changeSetName)
The name of the change set.
- Parameters:
changeSetName
- The name of the change set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setChangeSetId
public void setChangeSetId(String changeSetId)
The ARN of the change set.
- Parameters:
changeSetId
- The ARN of the change set.
-
getChangeSetId
public String getChangeSetId()
The ARN of the change set.
- Returns:
- The ARN of the change set.
-
withChangeSetId
public DescribeChangeSetResult withChangeSetId(String changeSetId)
The ARN of the change set.
- Parameters:
changeSetId
- The ARN of the change set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStackId
public void setStackId(String stackId)
The ARN of the stack that is associated with the change set.
- Parameters:
stackId
- The ARN of the stack that is associated with the change set.
-
getStackId
public String getStackId()
The ARN of the stack that is associated with the change set.
- Returns:
- The ARN of the stack that is associated with the change set.
-
withStackId
public DescribeChangeSetResult withStackId(String stackId)
The ARN of the stack that is associated with the change set.
- Parameters:
stackId
- The ARN of the stack that is associated with the change set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStackName
public void setStackName(String stackName)
The name of the stack that is associated with the change set.
- Parameters:
stackName
- The name of the stack that is associated with the change set.
-
getStackName
public String getStackName()
The name of the stack that is associated with the change set.
- Returns:
- The name of the stack that is associated with the change set.
-
withStackName
public DescribeChangeSetResult withStackName(String stackName)
The name of the stack that is associated with the change set.
- Parameters:
stackName
- The name of the stack that is associated with the change set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDescription
public void setDescription(String description)
Information about the change set.
- Parameters:
description
- Information about the change set.
-
getDescription
public String getDescription()
Information about the change set.
- Returns:
- Information about the change set.
-
withDescription
public DescribeChangeSetResult withDescription(String description)
Information about the change set.
- Parameters:
description
- Information about the change set.- 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 that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.- Returns:
- A list of
Parameter
structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.
-
setParameters
public void setParameters(Collection<Parameter> parameters)
A list of
Parameter
structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.- Parameters:
parameters
- A list ofParameter
structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.
-
withParameters
public DescribeChangeSetResult withParameters(Parameter... parameters)
A list of
Parameter
structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.NOTE: This method appends the values to the existing list (if any). Use
setParameters(java.util.Collection)
orwithParameters(java.util.Collection)
if you want to override the existing values.- Parameters:
parameters
- A list ofParameter
structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withParameters
public DescribeChangeSetResult withParameters(Collection<Parameter> parameters)
A list of
Parameter
structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.- Parameters:
parameters
- A list ofParameter
structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCreationTime
public void setCreationTime(Date creationTime)
The start time when the change set was created, in UTC.
- Parameters:
creationTime
- The start time when the change set was created, in UTC.
-
getCreationTime
public Date getCreationTime()
The start time when the change set was created, in UTC.
- Returns:
- The start time when the change set was created, in UTC.
-
withCreationTime
public DescribeChangeSetResult withCreationTime(Date creationTime)
The start time when the change set was created, in UTC.
- Parameters:
creationTime
- The start time when the change set was created, in UTC.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setExecutionStatus
public void setExecutionStatus(String executionStatus)
If the change set execution status is
AVAILABLE
, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in anUNAVAILABLE
state because AWS CloudFormation is still creating it or in anOBSOLETE
state because the stack was already updated.- Parameters:
executionStatus
- If the change set execution status isAVAILABLE
, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in anUNAVAILABLE
state because AWS CloudFormation is still creating it or in anOBSOLETE
state because the stack was already updated.- See Also:
ExecutionStatus
-
getExecutionStatus
public String getExecutionStatus()
If the change set execution status is
AVAILABLE
, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in anUNAVAILABLE
state because AWS CloudFormation is still creating it or in anOBSOLETE
state because the stack was already updated.- Returns:
- If the change set execution status is
AVAILABLE
, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in anUNAVAILABLE
state because AWS CloudFormation is still creating it or in anOBSOLETE
state because the stack was already updated. - See Also:
ExecutionStatus
-
withExecutionStatus
public DescribeChangeSetResult withExecutionStatus(String executionStatus)
If the change set execution status is
AVAILABLE
, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in anUNAVAILABLE
state because AWS CloudFormation is still creating it or in anOBSOLETE
state because the stack was already updated.- Parameters:
executionStatus
- If the change set execution status isAVAILABLE
, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in anUNAVAILABLE
state because AWS CloudFormation is still creating it or in anOBSOLETE
state because the stack was already updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ExecutionStatus
-
setExecutionStatus
public void setExecutionStatus(ExecutionStatus executionStatus)
If the change set execution status is
AVAILABLE
, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in anUNAVAILABLE
state because AWS CloudFormation is still creating it or in anOBSOLETE
state because the stack was already updated.- Parameters:
executionStatus
- If the change set execution status isAVAILABLE
, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in anUNAVAILABLE
state because AWS CloudFormation is still creating it or in anOBSOLETE
state because the stack was already updated.- See Also:
ExecutionStatus
-
withExecutionStatus
public DescribeChangeSetResult withExecutionStatus(ExecutionStatus executionStatus)
If the change set execution status is
AVAILABLE
, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in anUNAVAILABLE
state because AWS CloudFormation is still creating it or in anOBSOLETE
state because the stack was already updated.- Parameters:
executionStatus
- If the change set execution status isAVAILABLE
, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in anUNAVAILABLE
state because AWS CloudFormation is still creating it or in anOBSOLETE
state because the stack was already updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ExecutionStatus
-
setStatus
public void setStatus(String status)
The current status of the change set, such as
CREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.- Parameters:
status
- The current status of the change set, such asCREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.- See Also:
ChangeSetStatus
-
getStatus
public String getStatus()
The current status of the change set, such as
CREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.- Returns:
- The current status of the change set, such as
CREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
. - See Also:
ChangeSetStatus
-
withStatus
public DescribeChangeSetResult withStatus(String status)
The current status of the change set, such as
CREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.- Parameters:
status
- The current status of the change set, such asCREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ChangeSetStatus
-
setStatus
public void setStatus(ChangeSetStatus status)
The current status of the change set, such as
CREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.- Parameters:
status
- The current status of the change set, such asCREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.- See Also:
ChangeSetStatus
-
withStatus
public DescribeChangeSetResult withStatus(ChangeSetStatus status)
The current status of the change set, such as
CREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.- Parameters:
status
- The current status of the change set, such asCREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ChangeSetStatus
-
setStatusReason
public void setStatusReason(String statusReason)
A description of the change set's status. For example, if your attempt to create a change set failed, AWS CloudFormation shows the error message.
- Parameters:
statusReason
- A description of the change set's status. For example, if your attempt to create a change set failed, AWS CloudFormation shows the error message.
-
getStatusReason
public String getStatusReason()
A description of the change set's status. For example, if your attempt to create a change set failed, AWS CloudFormation shows the error message.
- Returns:
- A description of the change set's status. For example, if your attempt to create a change set failed, AWS CloudFormation shows the error message.
-
withStatusReason
public DescribeChangeSetResult withStatusReason(String statusReason)
A description of the change set's status. For example, if your attempt to create a change set failed, AWS CloudFormation shows the error message.
- Parameters:
statusReason
- A description of the change set's status. For example, if your attempt to create a change set failed, AWS CloudFormation shows the error message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getNotificationARNs
public List<String> getNotificationARNs()
The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
- Returns:
- The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
-
setNotificationARNs
public void setNotificationARNs(Collection<String> notificationARNs)
The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
- Parameters:
notificationARNs
- The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
-
withNotificationARNs
public DescribeChangeSetResult withNotificationARNs(String... notificationARNs)
The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
NOTE: This method appends the values to the existing list (if any). Use
setNotificationARNs(java.util.Collection)
orwithNotificationARNs(java.util.Collection)
if you want to override the existing values.- Parameters:
notificationARNs
- The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withNotificationARNs
public DescribeChangeSetResult withNotificationARNs(Collection<String> notificationARNs)
The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
- Parameters:
notificationARNs
- The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getCapabilities
public List<String> getCapabilities()
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
- Returns:
- If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
- See Also:
Capability
-
setCapabilities
public void setCapabilities(Collection<String> capabilities)
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
- Parameters:
capabilities
- If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.- See Also:
Capability
-
withCapabilities
public DescribeChangeSetResult withCapabilities(String... capabilities)
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
NOTE: This method appends the values to the existing list (if any). Use
setCapabilities(java.util.Collection)
orwithCapabilities(java.util.Collection)
if you want to override the existing values.- Parameters:
capabilities
- If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
Capability
-
withCapabilities
public DescribeChangeSetResult withCapabilities(Collection<String> capabilities)
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
- Parameters:
capabilities
- If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
Capability
-
withCapabilities
public DescribeChangeSetResult withCapabilities(Capability... capabilities)
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
- Parameters:
capabilities
- If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
Capability
-
getTags
public List<Tag> getTags()
If you execute the change set, the tags that will be associated with the stack.
- Returns:
- If you execute the change set, the tags that will be associated with the stack.
-
setTags
public void setTags(Collection<Tag> tags)
If you execute the change set, the tags that will be associated with the stack.
- Parameters:
tags
- If you execute the change set, the tags that will be associated with the stack.
-
withTags
public DescribeChangeSetResult withTags(Tag... tags)
If you execute the change set, the tags that will be associated with the stack.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
orwithTags(java.util.Collection)
if you want to override the existing values.- Parameters:
tags
- If you execute the change set, the tags that will be associated with the stack.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withTags
public DescribeChangeSetResult withTags(Collection<Tag> tags)
If you execute the change set, the tags that will be associated with the stack.
- Parameters:
tags
- If you execute the change set, the tags that will be associated with the stack.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getChanges
public List<Change> getChanges()
A list of
Change
structures that describes the resources AWS CloudFormation changes if you execute the change set.- Returns:
- A list of
Change
structures that describes the resources AWS CloudFormation changes if you execute the change set.
-
setChanges
public void setChanges(Collection<Change> changes)
A list of
Change
structures that describes the resources AWS CloudFormation changes if you execute the change set.- Parameters:
changes
- A list ofChange
structures that describes the resources AWS CloudFormation changes if you execute the change set.
-
withChanges
public DescribeChangeSetResult withChanges(Change... changes)
A list of
Change
structures that describes the resources AWS CloudFormation changes if you execute the change set.NOTE: This method appends the values to the existing list (if any). Use
setChanges(java.util.Collection)
orwithChanges(java.util.Collection)
if you want to override the existing values.- Parameters:
changes
- A list ofChange
structures that describes the resources AWS CloudFormation changes if you execute the change set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withChanges
public DescribeChangeSetResult withChanges(Collection<Change> changes)
A list of
Change
structures that describes the resources AWS CloudFormation changes if you execute the change set.- Parameters:
changes
- A list ofChange
structures that describes the resources AWS CloudFormation changes if you execute the change set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNextToken
public void setNextToken(String nextToken)
If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.
- Parameters:
nextToken
- If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.
-
getNextToken
public String getNextToken()
If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.
- Returns:
- If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.
-
withNextToken
public DescribeChangeSetResult withNextToken(String nextToken)
If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.
- Parameters:
nextToken
- If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.- 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DescribeChangeSetResult clone()
-
-