StackSetOperation - Amazon CloudFormation
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

StackSetOperation

The structure that contains information about a stack set operation.

Contents

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.

Type: String

Valid Values: CREATE | UPDATE | DELETE | DETECT_DRIFT

Required: No

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 Amazon CloudFormation User Guide.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: No

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 Amazon CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.

Type: Timestamp

Required: No

DeploymentTargets

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

Type: DeploymentTargets object

Required: No

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.

Type: Timestamp

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z_0-9+=,.@-]+

Required: No

OperationId

The unique ID of a stack set operation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9][-a-zA-Z0-9]*

Required: No

OperationPreferences

The preferences for how Amazon CloudFormation performs this stack set operation.

Type: StackSetOperationPreferences object

Required: No

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.

Type: Boolean

Required: No

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

Type: StackSetDriftDetectionDetails object

Required: No

StackSetId

The ID of the stack set.

Type: String

Required: No

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

Type: String

Valid Values: RUNNING | SUCCEEDED | FAILED | STOPPING | STOPPED | QUEUED

Required: No

StatusDetails

Detailed information about the StackSet operation.

Type: StackSetOperationStatusDetails object

Required: No

StatusReason

The status of the operation in details.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: