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.

DeleteStackInstancesInput

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

type DeleteStackInstancesInput struct { Accounts []*string `type:"list" required:"true"` OperationId *string `min:"1" type:"string" idempotencyToken:"true"` OperationPreferences *StackSetOperationPreferences `type:"structure"` Regions []*string `type:"list" required:"true"` RetainStacks *bool `type:"boolean" required:"true"` StackSetName *string `type:"string" required:"true"` }

Accounts

Type: []*string

The names of the AWS accounts that you want to delete stack instances for.

Accounts is a required field

OperationId

Type: *string

The unique identifier for this stack set operation.

If you don't specify an operation ID, the SDK generates one automatically.

The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that AWS CloudFormation successfully received them.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

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

Regions

Type: []*string

The regions where you want to delete stack set instances.

Regions is a required field

RetainStacks

Type: *bool

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

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

RetainStacks is a required field

StackSetName

Type: *string

The name or unique ID of the stack set that you want to delete stack instances for.

StackSetName is a required field

Method

GoString

func (s DeleteStackInstancesInput) GoString() string

GoString returns the string representation

SetAccounts

func (s *DeleteStackInstancesInput) SetAccounts(v []*string) *DeleteStackInstancesInput

SetAccounts sets the Accounts field's value.

SetOperationId

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

SetOperationId sets the OperationId field's value.

SetOperationPreferences

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

SetOperationPreferences sets the OperationPreferences field's value.

SetRegions

func (s *DeleteStackInstancesInput) SetRegions(v []*string) *DeleteStackInstancesInput

SetRegions sets the Regions field's value.

SetRetainStacks

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

SetRetainStacks sets the RetainStacks field's value.

SetStackSetName

func (s *DeleteStackInstancesInput) SetStackSetName(v string) *DeleteStackInstancesInput

SetStackSetName sets the StackSetName field's value.

String

func (s DeleteStackInstancesInput) String() string

String returns the string representation

Validate

func (s *DeleteStackInstancesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: