software.amazon.awssdk.services.cloudformation.model

Class ChangeSetSummary

java.lang.Object

software.amazon.awssdk.services.cloudformation.model.ChangeSetSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ChangeSetSummary.Builder,ChangeSetSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class ChangeSetSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ChangeSetSummary.Builder,ChangeSetSummary>

The ChangeSetSummary structure describes a change set, its status, and the stack with which it's associated.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ChangeSetSummary.Builder

Method Summary

Modifier and Type	Method and Description
static ChangeSetSummary.Builder	builder()
String	changeSetId() The ID of the change set.
String	changeSetName() The name of the change set.
Instant	creationTime() The start time when the change set was created, in UTC.
String	description() Descriptive information about the change set.
boolean	equals(Object obj)
ExecutionStatus	executionStatus() If the change set execution status is AVAILABLE, you can execute the change set.
String	executionStatusAsString() If the change set execution status is AVAILABLE, you can execute the change set.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ChangeSetSummary.Builder>	serializableBuilderClass()
String	stackId() The ID of the stack with which the change set is associated.
String	stackName() The name of the stack with which the change set is associated.
ChangeSetStatus	status() The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.
String	statusAsString() The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.
String	statusReason() A description of the change set's status.
ChangeSetSummary.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

stackId

public String 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

public String 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

public String changeSetId()

The ID of the change set.

Returns:

The ID of the change set.

changeSetName

public String changeSetName()

The name of the change set.

Returns:

The name of the change set.

executionStatus

public 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.

If the service returns an enum value that is not available in the current SDK version, executionStatus will return ExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from executionStatusAsString().

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 an UNAVAILABLE state because AWS CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

See Also:

ExecutionStatus

executionStatusAsString

public String 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 an UNAVAILABLE state because AWS CloudFormation is still creating it or in an OBSOLETE 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 return ExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from executionStatusAsString().

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 an UNAVAILABLE state because AWS CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

See Also:

ExecutionStatus

status

public ChangeSetStatus status()

The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

If the service returns an enum value that is not available in the current SDK version, status will return ChangeSetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

See Also:

ChangeSetStatus

statusAsString

public String statusAsString()

The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

If the service returns an enum value that is not available in the current SDK version, status will return ChangeSetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

See Also:

ChangeSetStatus

statusReason

public String statusReason()

A description of the change set's status. For example, if your change set is in the FAILED state, AWS 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, AWS CloudFormation shows the error message.

creationTime

public Instant 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

public String description()

Descriptive information about the change set.

Returns:

Descriptive information about the change set.

toBuilder

public ChangeSetSummary.Builder 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 interface ToCopyableBuilder<ChangeSetSummary.Builder,ChangeSetSummary>

Returns:

a builder for type T

builder

public static ChangeSetSummary.Builder builder()

serializableBuilderClass

public static Class<? extends ChangeSetSummary.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.