Package software.amazon.awssdk.services.cloudformation.model

Class StackSetOperationSummary

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

The structures that contain summary information about the specified operation.

See Also:

  • Method Details

    • operationId

      public final String operationId()

      The unique ID of the stack set operation.

      Returns:
      The unique ID of the stack set operation.

    • action

      public final StackSetOperationAction action()

      The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself and all associated stack set instances.

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

      Returns:
      The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself and all associated stack set instances.
      See Also:

    • actionAsString

      public final String actionAsString()

      The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself and all associated stack set instances.

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

      Returns:
      The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself and all associated stack set instances.
      See Also:

    • status

      public final StackSetOperationStatus status()

      The overall status of the operation.

      • FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.

      • QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.

      • RUNNING: The operation is currently being performed.

      • STOPPED: The user has canceled the operation.

      • STOPPING: The operation is in the process of stopping, at user request.

      • SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.

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

      Returns:
      The overall status of the operation.

      • FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.

      • QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.

      • RUNNING: The operation is currently being performed.

      • STOPPED: The user has canceled the operation.

      • STOPPING: The operation is in the process of stopping, at user request.

      • SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.

      See Also:

    • statusAsString

      public final String statusAsString()

      The overall status of the operation.

      • FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.

      • QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.

      • RUNNING: The operation is currently being performed.

      • STOPPED: The user has canceled the operation.

      • STOPPING: The operation is in the process of stopping, at user request.

      • SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.

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

      Returns:
      The overall status of the operation.

      • FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.

      • QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the CloudFormation User Guide.

      • RUNNING: The operation is currently being performed.

      • STOPPED: The user has canceled the operation.

      • STOPPING: The operation is in the process of stopping, at user request.

      • SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.

      See Also:

    • creationTimestamp

      public final Instant creationTimestamp()

      The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.

      Returns:
      The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.

    • endTimestamp

      public final Instant endTimestamp()

      The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.

      Returns:
      The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.

    • statusReason

      public final String statusReason()

      The status of the operation in details.

      Returns:
      The status of the operation in details.

    • statusDetails

      public final StackSetOperationStatusDetails statusDetails()

      Detailed information about the stack set operation.

      Returns:
      Detailed information about the stack set operation.

    • operationPreferences

      public final StackSetOperationPreferences operationPreferences()

      The user-specified preferences for how CloudFormation performs a stack set operation.

      For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.

      Returns:
      The user-specified preferences for how CloudFormation performs a stack set operation.

      For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.

    • toBuilder

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

    • builder

      public static StackSetOperationSummary.Builder builder()

    • serializableBuilderClass

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