Class DescribeChangeSetResult
- All Implemented Interfaces:
Serializable
,Cloneable
The output for the DescribeChangeSet action.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.A list ofChange
structures that describes the resources AWS CloudFormation changes if you execute the change set.The ARN of the change set.The name of the change set.The start time when the change set was created, in UTC.Information about the change set.If the change set execution status isAVAILABLE
, you can execute the change set.If the output exceeds 1 MB, a string that identifies the next page of changes.The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.A list ofParameter
structures that describes the input parameters and their values used to create the change set.The ARN of the stack that is associated with the change set.The name of the stack that is associated with the change set.The current status of the change set, such asCREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.A description of the change set's status.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
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.toString()
Returns a string representation of this object; useful for testing and debugging.withCapabilities
(Capability... capabilities) If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.withCapabilities
(String... capabilities) If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.withCapabilities
(Collection<String> capabilities) If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.withChanges
(Change... changes) A list ofChange
structures that describes the resources AWS CloudFormation changes if you execute the change set.withChanges
(Collection<Change> changes) A list ofChange
structures that describes the resources AWS CloudFormation changes if you execute the change set.withChangeSetId
(String changeSetId) The ARN of the change set.withChangeSetName
(String changeSetName) The name of the change set.withCreationTime
(Date creationTime) The start time when the change set was created, in UTC.withDescription
(String description) Information about the change set.withExecutionStatus
(ExecutionStatus executionStatus) If the change set execution status isAVAILABLE
, you can execute the change set.withExecutionStatus
(String executionStatus) If the change set execution status isAVAILABLE
, you can execute the change set.withNextToken
(String nextToken) If the output exceeds 1 MB, a string that identifies the next page of changes.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.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.withParameters
(Parameter... parameters) A list ofParameter
structures that describes the input parameters and their values used to create the change set.withParameters
(Collection<Parameter> parameters) A list ofParameter
structures that describes the input parameters and their values used to create the change set.withStackId
(String stackId) The ARN of the stack that is associated with the change set.withStackName
(String stackName) The name of the stack that is associated with the change set.withStatus
(ChangeSetStatus status) The current status of the change set, such asCREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.withStatus
(String status) The current status of the change set, such asCREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.withStatusReason
(String statusReason) A description of the change set's status.If you execute the change set, the tags that will be associated with the stack.withTags
(Collection<Tag> tags) If you execute the change set, the tags that will be associated with the stack.
-
Constructor Details
-
DescribeChangeSetResult
public DescribeChangeSetResult()
-
-
Method Details
-
setChangeSetName
The name of the change set.
- Parameters:
changeSetName
- The name of the change set.
-
getChangeSetName
The name of the change set.
- Returns:
- The name of the change set.
-
withChangeSetName
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
The ARN of the change set.
- Parameters:
changeSetId
- The ARN of the change set.
-
getChangeSetId
The ARN of the change set.
- Returns:
- The ARN of the change set.
-
withChangeSetId
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
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
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
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
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
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
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
Information about the change set.
- Parameters:
description
- Information about the change set.
-
getDescription
Information about the change set.
- Returns:
- Information about the change set.
-
withDescription
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
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
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
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
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
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
The start time when the change set was created, in UTC.
- Returns:
- The start time when the change set was created, in UTC.
-
withCreationTime
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
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:
-
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:
-
withExecutionStatus
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:
-
setExecutionStatus
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:
-
withExecutionStatus
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:
-
setStatus
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:
-
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:
-
withStatus
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:
-
setStatus
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:
-
withStatus
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:
-
setStatusReason
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
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
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
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
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
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
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
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:
-
setCapabilities
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:
-
withCapabilities
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:
-
withCapabilities
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:
-
withCapabilities
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:
-
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
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
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
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
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
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
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
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-