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.

StackSetOperationPreferences

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

type StackSetOperationPreferences struct { FailureToleranceCount *int64 `type:"integer"` FailureTolerancePercentage *int64 `type:"integer"` MaxConcurrentCount *int64 `min:"1" type:"integer"` MaxConcurrentPercentage *int64 `min:"1" type:"integer"` RegionOrder []*string `type:"list"` }

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

FailureToleranceCount

Type: *int64

The number of accounts, per region, for which this operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions.

Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).

FailureTolerancePercentage

Type: *int64

The percentage of accounts, per region, for which this stack operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions.

When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number.

Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.

MaxConcurrentCount

Type: *int64

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount—MaxConcurrentCount is at most one more than the FailureToleranceCount .

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

MaxConcurrentPercentage

Type: *int64

The maximum percentage of accounts in which to perform this operation at one time.

When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

RegionOrder

Type: []*string

The order of the regions in where you want to perform the stack operation.

Method

GoString

func (s StackSetOperationPreferences) GoString() string

GoString returns the string representation

SetFailureToleranceCount

func (s *StackSetOperationPreferences) SetFailureToleranceCount(v int64) *StackSetOperationPreferences

SetFailureToleranceCount sets the FailureToleranceCount field's value.

SetFailureTolerancePercentage

func (s *StackSetOperationPreferences) SetFailureTolerancePercentage(v int64) *StackSetOperationPreferences

SetFailureTolerancePercentage sets the FailureTolerancePercentage field's value.

SetMaxConcurrentCount

func (s *StackSetOperationPreferences) SetMaxConcurrentCount(v int64) *StackSetOperationPreferences

SetMaxConcurrentCount sets the MaxConcurrentCount field's value.

SetMaxConcurrentPercentage

func (s *StackSetOperationPreferences) SetMaxConcurrentPercentage(v int64) *StackSetOperationPreferences

SetMaxConcurrentPercentage sets the MaxConcurrentPercentage field's value.

SetRegionOrder

func (s *StackSetOperationPreferences) SetRegionOrder(v []*string) *StackSetOperationPreferences

SetRegionOrder sets the RegionOrder field's value.

String

func (s StackSetOperationPreferences) String() string

String returns the string representation

Validate

func (s *StackSetOperationPreferences) Validate() error

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

On this page: