Amazonka.CloudFormation.Types.StackSetOperationPreferences

Documentation

data StackSetOperationPreferences

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

For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.

See: newStackSetOperationPreferences smart constructor.

Constructors

StackSetOperationPreferences'

Fields

• failureToleranceCount :: Maybe Natural

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

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

  By default, 0 is specified.

• failureTolerancePercentage :: Maybe Natural

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

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

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

  By default, 0 is specified.

• maxConcurrentCount :: Maybe Natural

  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.

  By default, 1 is specified.

• maxConcurrentPercentage :: Maybe Natural

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

  By default, 1 is specified.

• regionConcurrencyType :: Maybe RegionConcurrencyType

  The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

• regionOrder :: Maybe [Text]

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

Instances

ToQuery StackSetOperationPreferences

Defined in Amazonka.CloudFormation.Types.StackSetOperationPreferences

Methods

toQuery :: StackSetOperationPreferences -> QueryString

FromXML StackSetOperationPreferences

Defined in Amazonka.CloudFormation.Types.StackSetOperationPreferences

Methods

parseXML :: [Node] -> Either String StackSetOperationPreferences

Generic StackSetOperationPreferences

Defined in Amazonka.CloudFormation.Types.StackSetOperationPreferences

Associated Types

type Rep StackSetOperationPreferences :: Type -> Type

Methods

from :: StackSetOperationPreferences -> Rep StackSetOperationPreferences x

to :: Rep StackSetOperationPreferences x -> StackSetOperationPreferences

Read StackSetOperationPreferences

Defined in Amazonka.CloudFormation.Types.StackSetOperationPreferences

Methods

readsPrec :: Int -> ReadS StackSetOperationPreferences

readList :: ReadS [StackSetOperationPreferences]

readPrec :: ReadPrec StackSetOperationPreferences

readListPrec :: ReadPrec [StackSetOperationPreferences]

Show StackSetOperationPreferences

Defined in Amazonka.CloudFormation.Types.StackSetOperationPreferences

Methods

showsPrec :: Int -> StackSetOperationPreferences -> ShowS

show :: StackSetOperationPreferences -> String

showList :: [StackSetOperationPreferences] -> ShowS

NFData StackSetOperationPreferences

Defined in Amazonka.CloudFormation.Types.StackSetOperationPreferences

Methods

rnf :: StackSetOperationPreferences -> ()

Eq StackSetOperationPreferences

Defined in Amazonka.CloudFormation.Types.StackSetOperationPreferences

Methods

(==) :: StackSetOperationPreferences -> StackSetOperationPreferences -> Bool

(/=) :: StackSetOperationPreferences -> StackSetOperationPreferences -> Bool

Hashable StackSetOperationPreferences

Defined in Amazonka.CloudFormation.Types.StackSetOperationPreferences

Methods

hashWithSalt :: Int -> StackSetOperationPreferences -> Int

hash :: StackSetOperationPreferences -> Int

type Rep StackSetOperationPreferences

Defined in Amazonka.CloudFormation.Types.StackSetOperationPreferences

type Rep StackSetOperationPreferences = D1 ('MetaData "StackSetOperationPreferences" "Amazonka.CloudFormation.Types.StackSetOperationPreferences" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "StackSetOperationPreferences'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "failureToleranceCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "failureTolerancePercentage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "maxConcurrentCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: (S1 ('MetaSel ('Just "maxConcurrentPercentage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "regionConcurrencyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RegionConcurrencyType)) :*: S1 ('MetaSel ('Just "regionOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newStackSetOperationPreferences :: StackSetOperationPreferences

Create a value of StackSetOperationPreferences with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:failureToleranceCount:StackSetOperationPreferences', stackSetOperationPreferences_failureToleranceCount - The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

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

By default, 0 is specified.

$sel:failureTolerancePercentage:StackSetOperationPreferences', stackSetOperationPreferences_failureTolerancePercentage - The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

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

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

By default, 0 is specified.

$sel:maxConcurrentCount:StackSetOperationPreferences', stackSetOperationPreferences_maxConcurrentCount - 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.

By default, 1 is specified.

$sel:maxConcurrentPercentage:StackSetOperationPreferences', stackSetOperationPreferences_maxConcurrentPercentage - 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, 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.

By default, 1 is specified.

$sel:regionConcurrencyType:StackSetOperationPreferences', stackSetOperationPreferences_regionConcurrencyType - The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

$sel:regionOrder:StackSetOperationPreferences', stackSetOperationPreferences_regionOrder - The order of the Regions in where you want to perform the stack operation.

stackSetOperationPreferences_failureToleranceCount :: Lens' StackSetOperationPreferences (Maybe Natural)

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

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

By default, 0 is specified.

stackSetOperationPreferences_failureTolerancePercentage :: Lens' StackSetOperationPreferences (Maybe Natural)

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

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

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

By default, 0 is specified.

stackSetOperationPreferences_maxConcurrentCount :: Lens' StackSetOperationPreferences (Maybe Natural)

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.

By default, 1 is specified.

stackSetOperationPreferences_maxConcurrentPercentage :: Lens' StackSetOperationPreferences (Maybe Natural)

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

By default, 1 is specified.

stackSetOperationPreferences_regionConcurrencyType :: Lens' StackSetOperationPreferences (Maybe RegionConcurrencyType)

The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

stackSetOperationPreferences_regionOrder :: Lens' StackSetOperationPreferences (Maybe [Text])

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