class Aws::CloudFormation::Types::StackSetOperation

The structure that contains information about a stack set operation.

@!attribute [rw] operation_id

The unique ID of a stack set operation.
@return [String]

@!attribute [rw] stack_set_id

The ID of the stack set.
@return [String]

@!attribute [rw] 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.
@return [String]

@!attribute [rw] 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][1] 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.

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes
@return [String]

@!attribute [rw] operation_preferences

The preferences for how CloudFormation performs this stack set
operation.
@return [Types::StackSetOperationPreferences]

@!attribute [rw] retain_stacks

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.
@return [Boolean]

@!attribute [rw] administration_role_arn

The Amazon Resource Number (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][1] in the *CloudFormation User Guide*.

[1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html
@return [String]

@!attribute [rw] execution_role_name

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.
@return [String]

@!attribute [rw] creation_timestamp

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.
@return [Time]

@!attribute [rw] end_timestamp

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.
@return [Time]

@!attribute [rw] deployment_targets

\[Service-managed permissions\] The Organizations accounts affected
by the stack operation.
@return [Types::DeploymentTargets]

@!attribute [rw] stack_set_drift_detection_details

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 [Detecting Unmanaged Changes in Stack
Sets][1] in the CloudFormation User Guide.

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html
@return [Types::StackSetDriftDetectionDetails]

@see docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackSetOperation AWS API Documentation

Constants

SENSITIVE