Class StackSetOperationResultSummary

java.lang.Object
software.amazon.awssdk.services.cloudformation.model.StackSetOperationResultSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<StackSetOperationResultSummary.Builder,StackSetOperationResultSummary>
@Generated("software.amazon.awssdk:codegen") public final class StackSetOperationResultSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<StackSetOperationResultSummary.Builder,StackSetOperationResultSummary>

The structure that contains information about a specified operation's results for a given account in a given Region.

See Also:

  • Method Details

    • account

      public final String account()

      [Self-managed permissions] The name of the Amazon Web Services account for this operation result.

      Returns:
      [Self-managed permissions] The name of the Amazon Web Services account for this operation result.

    • region

      public final String region()

      The name of the Amazon Web Services Region for this operation result.

      Returns:
      The name of the Amazon Web Services Region for this operation result.

    • status

      public final StackSetOperationResultStatus status()

      The result status of the stack set operation for the given account in the given Region.

      • CANCELLED: The operation in the specified account and Region has been canceled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.

      • FAILED: The operation in the specified account and Region failed.

        If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.

      • RUNNING: The operation in the specified account and Region is currently in progress.

      • PENDING: The operation in the specified account and Region has yet to start.

      • SUCCEEDED: The operation in the specified account and Region completed successfully.

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

      Returns:
      The result status of the stack set operation for the given account in the given Region.

      • CANCELLED: The operation in the specified account and Region has been canceled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.

      • FAILED: The operation in the specified account and Region failed.

        If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.

      • RUNNING: The operation in the specified account and Region is currently in progress.

      • PENDING: The operation in the specified account and Region has yet to start.

      • SUCCEEDED: The operation in the specified account and Region completed successfully.

      See Also:

    • statusAsString

      public final String statusAsString()

      The result status of the stack set operation for the given account in the given Region.

      • CANCELLED: The operation in the specified account and Region has been canceled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.

      • FAILED: The operation in the specified account and Region failed.

        If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.

      • RUNNING: The operation in the specified account and Region is currently in progress.

      • PENDING: The operation in the specified account and Region has yet to start.

      • SUCCEEDED: The operation in the specified account and Region completed successfully.

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

      Returns:
      The result status of the stack set operation for the given account in the given Region.

      • CANCELLED: The operation in the specified account and Region has been canceled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.

      • FAILED: The operation in the specified account and Region failed.

        If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.

      • RUNNING: The operation in the specified account and Region is currently in progress.

      • PENDING: The operation in the specified account and Region has yet to start.

      • SUCCEEDED: The operation in the specified account and Region completed successfully.

      See Also:

    • statusReason

      public final String statusReason()

      The reason for the assigned result status.

      Returns:
      The reason for the assigned result status.

    • accountGateResult

      public final AccountGateResult accountGateResult()

      The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set operations in an account.

      Returns:
      The results of the account gate function CloudFormation invokes, if present, before proceeding with stack set operations in an account.

    • organizationalUnitId

      public final String organizationalUnitId()

      [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

      Returns:
      [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

    • toBuilder

      public StackSetOperationResultSummary.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<StackSetOperationResultSummary.Builder,StackSetOperationResultSummary>
      Returns:
      a builder for type T

    • builder

      public static StackSetOperationResultSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StackSetOperationResultSummary.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.