Class ChangeSetSummary

java.lang.Object
software.amazon.awssdk.services.cloudformation.model.ChangeSetSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ChangeSetSummary.Builder,ChangeSetSummary>
@Generated("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:

  • Method Details

    • 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:

    • 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:

    • status

      public final ChangeSetStatus status()

      The state of the change set, such as CREATE_PENDING, 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_PENDING, CREATE_COMPLETE, or FAILED.
      See Also:

    • statusAsString

      public final String statusAsString()

      The state of the change set, such as CREATE_PENDING, 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_PENDING, CREATE_COMPLETE, or FAILED.
      See Also:

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

    • importExistingResources

      public final Boolean importExistingResources()

      Indicates if the change set imports resources that already exist.

      Returns:
      Indicates if the change set imports resources that already exist.

    • 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 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.