AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

The structure that contains information about a stack set operation.

Inheritance Hierarchy


Namespace: Amazon.CloudFormation.Model
Assembly: AWSSDK.CloudFormation.dll
Version: 3.x.y.z


public class StackSetOperation

The StackSetOperation type exposes the following members


Public Method StackSetOperation()


Public Property Action Amazon.CloudFormation.StackSetOperationAction

Gets and sets the property 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, as well as all associated stack set instances.

Public Property AdministrationRoleARN System.String

Gets and sets the property AdministrationRoleARN.

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 in the AWS CloudFormation User Guide.

Public Property CreationTimestamp System.DateTime

Gets and sets the property 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 AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks.

Public Property EndTimestamp System.DateTime

Gets and sets the property 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.

Public Property ExecutionRoleName System.String

Gets and sets the property 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.

Public Property OperationId System.String

Gets and sets the property OperationId.

The unique ID of a stack set operation.

Public Property OperationPreferences Amazon.CloudFormation.Model.StackSetOperationPreferences

Gets and sets the property OperationPreferences.

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

Public Property RetainStacks System.Boolean

Gets and sets the property 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 reassociate a retained stack, or add an existing, saved stack to a new stack set.

Public Property StackSetId System.String

Gets and sets the property StackSetId.

The ID of the stack set.

Public Property Status Amazon.CloudFormation.StackSetOperationStatus

Gets and sets the property 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 AWS CloudFormation cancels the operation in any remaining regions.

  • RUNNING: The operation is currently being performed.

  • STOPPED: The user has cancelled 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.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms