public class DescribeChangeSetResult extends Object implements Serializable, Cloneable
The output for the DescribeChangeSet action.
Constructor and Description |
---|
DescribeChangeSetResult() |
Modifier and Type | Method and 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 of
Change 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 is
AVAILABLE , 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 of
Parameter 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 as
CREATE_IN_PROGRESS , CREATE_COMPLETE , or
FAILED . |
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 of
Change 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 is
AVAILABLE , you can
execute the change set. |
void |
setExecutionStatus(String executionStatus)
If the change set execution status is
AVAILABLE , 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 of
Parameter 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 as
CREATE_IN_PROGRESS , CREATE_COMPLETE , or
FAILED . |
void |
setStatus(String status)
The current status of the change set, such as
CREATE_IN_PROGRESS , CREATE_COMPLETE , or
FAILED . |
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(Collection<String> 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 |
withChanges(Change... changes)
A list of
Change structures that describes the resources AWS
CloudFormation changes if you execute the change set. |
DescribeChangeSetResult |
withChanges(Collection<Change> changes)
A list of
Change 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 is
AVAILABLE , you can
execute the change set. |
DescribeChangeSetResult |
withExecutionStatus(String executionStatus)
If the change set execution status is
AVAILABLE , 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(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 |
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 |
withParameters(Collection<Parameter> parameters)
A list of
Parameter structures that describes the input
parameters and their values used to create the change set. |
DescribeChangeSetResult |
withParameters(Parameter... parameters)
A list of
Parameter 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 as
CREATE_IN_PROGRESS , CREATE_COMPLETE , or
FAILED . |
DescribeChangeSetResult |
withStatus(String status)
The current status of the change set, such as
CREATE_IN_PROGRESS , CREATE_COMPLETE , or
FAILED . |
DescribeChangeSetResult |
withStatusReason(String statusReason)
A description of the change set's status.
|
DescribeChangeSetResult |
withTags(Collection<Tag> tags)
If you execute the change set, the tags that will be associated with the
stack.
|
DescribeChangeSetResult |
withTags(Tag... tags)
If you execute the change set, the tags that will be associated with the
stack.
|
public void setChangeSetName(String changeSetName)
The name of the change set.
changeSetName
- The name of the change set.public String getChangeSetName()
The name of the change set.
public DescribeChangeSetResult withChangeSetName(String changeSetName)
The name of the change set.
changeSetName
- The name of the change set.public void setChangeSetId(String changeSetId)
The ARN of the change set.
changeSetId
- The ARN of the change set.public String getChangeSetId()
The ARN of the change set.
public DescribeChangeSetResult withChangeSetId(String changeSetId)
The ARN of the change set.
changeSetId
- The ARN of the change set.public void setStackId(String stackId)
The ARN of the stack that is associated with the change set.
stackId
- The ARN of the stack that is associated with the change set.public String getStackId()
The ARN of the stack that is associated with the change set.
public DescribeChangeSetResult withStackId(String stackId)
The ARN of the stack that is associated with the change set.
stackId
- The ARN of the stack that is associated with the change set.public void setStackName(String stackName)
The name of the stack that is associated with the change set.
stackName
- The name of the stack that is associated with the change set.public String getStackName()
The name of the stack that is associated with the change set.
public DescribeChangeSetResult withStackName(String stackName)
The name of the stack that is associated with the change set.
stackName
- The name of the stack that is associated with the change set.public void setDescription(String description)
Information about the change set.
description
- Information about the change set.public String getDescription()
Information about the change set.
public DescribeChangeSetResult withDescription(String description)
Information about the change set.
description
- Information about the change set.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.
Parameter
structures that describes the
input parameters and their values used to create the change set.
For more information, see the Parameter data type.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
- 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.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)
or
withParameters(java.util.Collection)
if you want to override the
existing values.
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.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
- 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.public void setCreationTime(Date creationTime)
The start time when the change set was created, in UTC.
creationTime
- The start time when the change set was created, in UTC.public Date getCreationTime()
The start time when the change set was created, in UTC.
public DescribeChangeSetResult withCreationTime(Date creationTime)
The start time when the change set was created, in UTC.
creationTime
- The start time when the change set was created, in UTC.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 an
UNAVAILABLE
state because AWS CloudFormation is still
creating it or in an OBSOLETE
state because the stack was
already updated.
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 an
UNAVAILABLE
state because AWS CloudFormation is still
creating it or in an OBSOLETE
state because the stack
was already updated.ExecutionStatus
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 an
UNAVAILABLE
state because AWS CloudFormation is still
creating it or in an OBSOLETE
state because the stack was
already updated.
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
an UNAVAILABLE
state because AWS CloudFormation is
still creating it or in an OBSOLETE
state because
the stack was already updated.ExecutionStatus
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 an
UNAVAILABLE
state because AWS CloudFormation is still
creating it or in an OBSOLETE
state because the stack was
already updated.
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 an
UNAVAILABLE
state because AWS CloudFormation is still
creating it or in an OBSOLETE
state because the stack
was already updated.ExecutionStatus
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 an
UNAVAILABLE
state because AWS CloudFormation is still
creating it or in an OBSOLETE
state because the stack was
already updated.
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 an
UNAVAILABLE
state because AWS CloudFormation is still
creating it or in an OBSOLETE
state because the stack
was already updated.ExecutionStatus
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 an
UNAVAILABLE
state because AWS CloudFormation is still
creating it or in an OBSOLETE
state because the stack was
already updated.
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 an
UNAVAILABLE
state because AWS CloudFormation is still
creating it or in an OBSOLETE
state because the stack
was already updated.ExecutionStatus
public void setStatus(String status)
The current status of the change set, such as
CREATE_IN_PROGRESS
, CREATE_COMPLETE
, or
FAILED
.
status
- The current status of the change set, such as
CREATE_IN_PROGRESS
, CREATE_COMPLETE
, or
FAILED
.ChangeSetStatus
public String getStatus()
The current status of the change set, such as
CREATE_IN_PROGRESS
, CREATE_COMPLETE
, or
FAILED
.
CREATE_IN_PROGRESS
, CREATE_COMPLETE
, or
FAILED
.ChangeSetStatus
public DescribeChangeSetResult withStatus(String status)
The current status of the change set, such as
CREATE_IN_PROGRESS
, CREATE_COMPLETE
, or
FAILED
.
status
- The current status of the change set, such as
CREATE_IN_PROGRESS
, CREATE_COMPLETE
, or
FAILED
.ChangeSetStatus
public void setStatus(ChangeSetStatus status)
The current status of the change set, such as
CREATE_IN_PROGRESS
, CREATE_COMPLETE
, or
FAILED
.
status
- The current status of the change set, such as
CREATE_IN_PROGRESS
, CREATE_COMPLETE
, or
FAILED
.ChangeSetStatus
public DescribeChangeSetResult withStatus(ChangeSetStatus status)
The current status of the change set, such as
CREATE_IN_PROGRESS
, CREATE_COMPLETE
, or
FAILED
.
status
- The current status of the change set, such as
CREATE_IN_PROGRESS
, CREATE_COMPLETE
, or
FAILED
.ChangeSetStatus
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.
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.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.
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.
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.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.
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.
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.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)
or
withNotificationARNs(java.util.Collection)
if you want to
override the existing values.
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.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.
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.public List<String> getCapabilities()
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
Capability
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.
capabilities
- If you execute the change set, the list of capabilities that were
explicitly acknowledged when the change set was created.Capability
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)
or
withCapabilities(java.util.Collection)
if you want to override
the existing values.
capabilities
- If you execute the change set, the list of capabilities that were
explicitly acknowledged when the change set was created.Capability
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.
capabilities
- If you execute the change set, the list of capabilities that were
explicitly acknowledged when the change set was created.Capability
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.
capabilities
- If you execute the change set, the list of capabilities that were
explicitly acknowledged when the change set was created.Capability
public List<Tag> getTags()
If you execute the change set, the tags that will be associated with the stack.
public void setTags(Collection<Tag> tags)
If you execute the change set, the tags that will be associated with the stack.
tags
- If you execute the change set, the tags that will be associated
with the stack.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)
or
withTags(java.util.Collection)
if you want to override the
existing values.
tags
- If you execute the change set, the tags that will be associated
with the stack.public DescribeChangeSetResult withTags(Collection<Tag> tags)
If you execute the change set, the tags that will be associated with the stack.
tags
- If you execute the change set, the tags that will be associated
with the stack.public List<Change> getChanges()
A list of Change
structures that describes the resources AWS
CloudFormation changes if you execute the change set.
Change
structures that describes the
resources AWS CloudFormation changes if you execute the change
set.public void setChanges(Collection<Change> changes)
A list of Change
structures that describes the resources AWS
CloudFormation changes if you execute the change set.
changes
- A list of Change
structures that describes the
resources AWS CloudFormation changes if you execute the change
set.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)
or
withChanges(java.util.Collection)
if you want to override the
existing values.
changes
- A list of Change
structures that describes the
resources AWS CloudFormation changes if you execute the change
set.public DescribeChangeSetResult withChanges(Collection<Change> changes)
A list of Change
structures that describes the resources AWS
CloudFormation changes if you execute the change set.
changes
- A list of Change
structures that describes the
resources AWS CloudFormation changes if you execute the change
set.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.
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.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.
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.
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.public String toString()
toString
in class Object
Object.toString()
public DescribeChangeSetResult clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.