ChangeSetSummary (AWS Java SDK :: Services :: AWS CloudFormation 2.17.69 API)

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ChangeSetSummary.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`boolean`	`equalsBySdkFields(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()`
`Boolean`	`includeNestedStacks()` Specifies the current setting of `IncludeNestedStacks` for the change set.
`String`	`parentChangeSetId()` The parent change set ID.
`String`	`rootChangeSetId()` The root change set ID.
`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()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - stackId
```
public final 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 final 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 final String changeSetId()
```
    The ID of the change set.
    
    Returns:
    
    The ID of the change set.
  - changeSetName
```
public final String changeSetName()
```
    The name of the change set.
    
    Returns:
    
    The name of the change set.
  - executionStatus
```
public final 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 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 CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.
    
    See Also:
    
    ExecutionStatus
  - executionStatusAsString
```
public final 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 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 CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.
    
    See Also:
    
    ExecutionStatus
  - status
```
public final 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 final 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 final String 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
```
public final 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 final String description()
```
    Descriptive information about the change set.
    
    Returns:
    
    Descriptive information about the change set.
  - includeNestedStacks
```
public final Boolean includeNestedStacks()
```
    Specifies the current setting of IncludeNestedStacks for the change set.
    
    Returns:
    
    Specifies the current setting of IncludeNestedStacks for the change set.
  - parentChangeSetId
```
public final String parentChangeSetId()
```
    The parent change set ID.
    
    Returns:
    
    The parent change set ID.
  - rootChangeSetId
```
public final String rootChangeSetId()
```
    The root change set ID.
    
    Returns:
    
    The root change set ID.
  - toBuilder
```
public ChangeSetSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ChangeSetSummary.Builder,ChangeSetSummary>
  - builder
```
public static ChangeSetSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ChangeSetSummary.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ChangeSetSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

stackId

stackName

changeSetId

changeSetName

executionStatus

executionStatusAsString

status

statusAsString

statusReason

creationTime

description

includeNestedStacks

parentChangeSetId

rootChangeSetId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields