Class ChangeSetSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ChangeSetSummary.Builder,
ChangeSetSummary>
The ChangeSetSummary
structure describes a change set, its status, and the stack with which it's
associated.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ChangeSetSummary.Builder
builder()
final String
The ID of the change set.final String
The name of the change set.final Instant
The start time when the change set was created, in UTC.final String
Descriptive information about the change set.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ExecutionStatus
If the change set execution status isAVAILABLE
, you can execute the change set.final String
If the change set execution status isAVAILABLE
, you can execute the change set.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Boolean
Indicates if the change set imports resources that already exist.final Boolean
Specifies the current setting ofIncludeNestedStacks
for the change set.final String
The parent change set ID.final String
The root change set ID.static Class
<? extends ChangeSetSummary.Builder> final String
stackId()
The ID of the stack with which the change set is associated.final String
The name of the stack with which the change set is associated.final ChangeSetStatus
status()
The state of the change set, such asCREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.final String
The state of the change set, such asCREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.final String
A description of the change set's status.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
stackId
The ID of the stack with which the change set is associated.
- Returns:
- The ID of the stack with which the change set is associated.
-
stackName
The name of the stack with which the change set is associated.
- Returns:
- The name of the stack with which the change set is associated.
-
changeSetId
The ID of the change set.
- Returns:
- The ID of the change set.
-
changeSetName
The name of the change set.
- Returns:
- The name of the change set.
-
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 CloudFormation is still creating it or in anOBSOLETE
state because the stack was already updated.If the service returns an enum value that is not available in the current SDK version,
executionStatus
will returnExecutionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromexecutionStatusAsString()
.- 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 CloudFormation is still creating it or in anOBSOLETE
state because the stack was already updated. - See Also:
-
executionStatusAsString
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 CloudFormation is still creating it or in anOBSOLETE
state because the stack was already updated.If the service returns an enum value that is not available in the current SDK version,
executionStatus
will returnExecutionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromexecutionStatusAsString()
.- 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 CloudFormation is still creating it or in anOBSOLETE
state because the stack was already updated. - See Also:
-
status
The state of the change set, such as
CREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.If the service returns an enum value that is not available in the current SDK version,
status
will returnChangeSetStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The state of the change set, such as
CREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
. - See Also:
-
statusAsString
The state of the change set, such as
CREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
.If the service returns an enum value that is not available in the current SDK version,
status
will returnChangeSetStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The state of the change set, such as
CREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
. - See Also:
-
statusReason
A description of the change set's status. For example, if your change set is in the
FAILED
state, CloudFormation shows the error message.- Returns:
- A description of the change set's status. For example, if your change set is in the
FAILED
state, CloudFormation shows the error message.
-
creationTime
The start time when the change set was created, in UTC.
- Returns:
- The start time when the change set was created, in UTC.
-
description
Descriptive information about the change set.
- Returns:
- Descriptive information about the change set.
-
includeNestedStacks
Specifies the current setting of
IncludeNestedStacks
for the change set.- Returns:
- Specifies the current setting of
IncludeNestedStacks
for the change set.
-
parentChangeSetId
The parent change set ID.
- Returns:
- The parent change set ID.
-
rootChangeSetId
The root change set ID.
- Returns:
- The root change set ID.
-
importExistingResources
Indicates if the change set imports resources that already exist.
- Returns:
- Indicates if the change set imports resources that already exist.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ChangeSetSummary.Builder,
ChangeSetSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-