AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

StackSetOperation

import "github.com/aws/aws-sdk-go/service/cloudformation"

type StackSetOperation struct { Action *string `type:"string" enum:"StackSetOperationAction"` AdministrationRoleARN *string `min:"20" type:"string"` CreationTimestamp *time.Time `type:"timestamp"` EndTimestamp *time.Time `type:"timestamp"` ExecutionRoleName *string `min:"1" type:"string"` OperationId *string `min:"1" type:"string"` OperationPreferences *StackSetOperationPreferences `type:"structure"` RetainStacks *bool `type:"boolean"` StackSetId *string `type:"string"` Status *string `type:"string" enum:"StackSetOperationStatus"` }

The structure that contains information about a stack set operation.

Action

Type: *string

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.

AdministrationRoleARN

Type: *string

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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) in the AWS CloudFormation User Guide.

CreationTimestamp

Type: *time.Time

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.

EndTimestamp

Type: *time.Time

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.

ExecutionRoleName

Type: *string

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.

OperationId

Type: *string

The unique ID of a stack set operation.

OperationPreferences

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

For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options).

RetainStacks

Type: *bool

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.

StackSetId

Type: *string

The ID of the stack set.

Status

Type: *string

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.

Method

GoString

func (s StackSetOperation) GoString() string

GoString returns the string representation

SetAction

func (s *StackSetOperation) SetAction(v string) *StackSetOperation

SetAction sets the Action field's value.

SetAdministrationRoleARN

func (s *StackSetOperation) SetAdministrationRoleARN(v string) *StackSetOperation

SetAdministrationRoleARN sets the AdministrationRoleARN field's value.

SetCreationTimestamp

func (s *StackSetOperation) SetCreationTimestamp(v time.Time) *StackSetOperation

SetCreationTimestamp sets the CreationTimestamp field's value.

SetEndTimestamp

func (s *StackSetOperation) SetEndTimestamp(v time.Time) *StackSetOperation

SetEndTimestamp sets the EndTimestamp field's value.

SetExecutionRoleName

func (s *StackSetOperation) SetExecutionRoleName(v string) *StackSetOperation

SetExecutionRoleName sets the ExecutionRoleName field's value.

SetOperationId

func (s *StackSetOperation) SetOperationId(v string) *StackSetOperation

SetOperationId sets the OperationId field's value.

SetOperationPreferences

func (s *StackSetOperation) SetOperationPreferences(v *StackSetOperationPreferences) *StackSetOperation

SetOperationPreferences sets the OperationPreferences field's value.

SetRetainStacks

func (s *StackSetOperation) SetRetainStacks(v bool) *StackSetOperation

SetRetainStacks sets the RetainStacks field's value.

SetStackSetId

func (s *StackSetOperation) SetStackSetId(v string) *StackSetOperation

SetStackSetId sets the StackSetId field's value.

SetStatus

func (s *StackSetOperation) SetStatus(v string) *StackSetOperation

SetStatus sets the Status field's value.

String

func (s StackSetOperation) String() string

String returns the string representation

On this page: