Class ChangeSetSummary

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

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)