Class StackSetOperation

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

The structure that contains information about a stack set operation.

See Also:

  • Method Details

    • operationId

      public final String operationId()

      The unique ID of a stack set operation.

      Returns:
      The unique ID of a stack set operation.

    • stackSetId

      public final String stackSetId()

      The ID of the stack set.

      Returns:
      The ID of the stack set.

    • action

      public final StackSetOperationAction action()

      The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, in addition to 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 stack set operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, in addition to all associated stack set instances.
      See Also:

    • actionAsString

      public final String actionAsString()

      The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, in addition to 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 stack set operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, in addition to all associated stack set instances.
      See Also:

    • status

      public final StackSetOperationStatus status()

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

    • operationPreferences

      public final StackSetOperationPreferences operationPreferences()

      The preferences for how CloudFormation performs this stack set operation.

      Returns:
      The preferences for how CloudFormation performs this stack set operation.

    • retainStacks

      public final Boolean retainStacks()

      For stack set operations of action type DELETE, specifies whether to remove the stack instances from the specified stack set, but doesn't delete the stacks. You can't re-associate a retained stack, or add an existing, saved stack to a new stack set.

      Returns:
      For stack set operations of action type DELETE, specifies whether to remove the stack instances from the specified stack set, but doesn't delete the stacks. You can't re-associate a retained stack, or add an existing, saved stack to a new stack set.

    • administrationRoleARN

      public final String administrationRoleARN()

      The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.

      Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the CloudFormation User Guide.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.

      Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the CloudFormation User Guide.

    • executionRoleName

      public final String executionRoleName()

      The name of the IAM execution role used to create or update the stack set.

      Use customized execution roles to control which stack resources users and groups can include in their stack sets.

      Returns:
      The name of the IAM execution role used to create or update the stack set.

      Use customized execution roles to control which stack resources users and groups can include in their stack sets.

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

    • deploymentTargets

      public final DeploymentTargets deploymentTargets()

      [Service-managed permissions] The Organizations accounts affected by the stack operation.

      Returns:
      [Service-managed permissions] The Organizations accounts affected by the stack operation.

    • stackSetDriftDetectionDetails

      public final StackSetDriftDetectionDetails stackSetDriftDetectionDetails()

      Detailed information about the drift status of the stack set. This includes information about drift operations currently being performed on the stack set.

      This information will only be present for stack set operations whose Action type is DETECT_DRIFT.

      For more information, see Detect stack set drift in the CloudFormation User Guide.

      Returns:
      Detailed information about the drift status of the stack set. This includes information about drift operations currently being performed on the stack set.

      This information will only be present for stack set operations whose Action type is DETECT_DRIFT.

      For more information, see Detect stack set drift in the CloudFormation User Guide.

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

      Returns:
      Detailed information about the StackSet operation.

    • toBuilder

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

    • builder

      public static StackSetOperation.Builder builder()

    • serializableBuilderClass

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