/AWS1/CL_FRMSTACKSETOPPREFER00

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.

CONSTRUCTOR

IMPORTING

Optional arguments:

IV_REGIONCONCURRENCYTYPE TYPE /AWS1/FRMREGIONCONCURRENCYTYPE /AWS1/FRMREGIONCONCURRENCYTYPE

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

IT_REGIONORDER TYPE /AWS1/CL_FRMREGIONLIST_W=>TT_REGIONLIST TT_REGIONLIST

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

RegionOrder isn't followed if AutoDeployment is enabled.

IV_FAILURETOLERANCECOUNT TYPE /AWS1/FRMFAILURETOLERANCECOUNT /AWS1/FRMFAILURETOLERANCECOUNT

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.

IV_FAILURETOLERANCEPERCENT00 TYPE /AWS1/FRMFAILURETOLERANCEPER00 /AWS1/FRMFAILURETOLERANCEPER00

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.

IV_MAXCONCURRENTCOUNT TYPE /AWS1/FRMMAXCONCURRENTCOUNT /AWS1/FRMMAXCONCURRENTCOUNT

The maximum number of accounts in which to perform this operation at one time. This can depend on the value of FailureToleranceCount depending on your ConcurrencyMode. MaxConcurrentCount is at most one more than the FailureToleranceCount if you're using STRICT_FAILURE_TOLERANCE.

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.

IV_MAXCONCURRENTPERCENTAGE TYPE /AWS1/FRMMAXCONCURRENTPERCEN00 /AWS1/FRMMAXCONCURRENTPERCEN00

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.

IV_CONCURRENCYMODE TYPE /AWS1/FRMCONCURRENCYMODE /AWS1/FRMCONCURRENCYMODE

Specifies how the concurrency level behaves during the operation execution.

• STRICT_FAILURE_TOLERANCE: This option dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the value of FailureToleranceCount +1. The initial actual concurrency is set to the lower of either the value of the MaxConcurrentCount, or the value of FailureToleranceCount +1. The actual concurrency is then reduced proportionally by the number of failures. This is the default behavior.

  If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.

• SOFT_FAILURE_TOLERANCE: This option decouples FailureToleranceCount from the actual concurrency. This allows stack set operations to run at the concurrency level set by the MaxConcurrentCount value, or MaxConcurrentPercentage, regardless of the number of failures.

---

Queryable Attributes

RegionConcurrencyType

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

Accessible with the following methods

Method	Description
GET_REGIONCONCURRENCYTYPE()	Getter for REGIONCONCURRENCYTYPE, with configurable default
ASK_REGIONCONCURRENCYTYPE()	Getter for REGIONCONCURRENCYTYPE w/ exceptions if field has
HAS_REGIONCONCURRENCYTYPE()	Determine if REGIONCONCURRENCYTYPE has a value

RegionOrder

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

RegionOrder isn't followed if AutoDeployment is enabled.

Accessible with the following methods

Method	Description
GET_REGIONORDER()	Getter for REGIONORDER, with configurable default
ASK_REGIONORDER()	Getter for REGIONORDER w/ exceptions if field has no value
HAS_REGIONORDER()	Determine if REGIONORDER has a value

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.

Accessible with the following methods

Method	Description
GET_FAILURETOLERANCECOUNT()	Getter for FAILURETOLERANCECOUNT, with configurable default
ASK_FAILURETOLERANCECOUNT()	Getter for FAILURETOLERANCECOUNT w/ exceptions if field has
HAS_FAILURETOLERANCECOUNT()	Determine if FAILURETOLERANCECOUNT has a value

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.

Accessible with the following methods

Method	Description
GET_FAILURETOLERANCEPERCEN00()	Getter for FAILURETOLERANCEPERCENTAGE, with configurable def
ASK_FAILURETOLERANCEPERCEN00()	Getter for FAILURETOLERANCEPERCENTAGE w/ exceptions if field
HAS_FAILURETOLERANCEPERCEN00()	Determine if FAILURETOLERANCEPERCENTAGE has a value

MaxConcurrentCount

The maximum number of accounts in which to perform this operation at one time. This can depend on the value of FailureToleranceCount depending on your ConcurrencyMode. MaxConcurrentCount is at most one more than the FailureToleranceCount if you're using STRICT_FAILURE_TOLERANCE.

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.

Accessible with the following methods

Method	Description
GET_MAXCONCURRENTCOUNT()	Getter for MAXCONCURRENTCOUNT, with configurable default
ASK_MAXCONCURRENTCOUNT()	Getter for MAXCONCURRENTCOUNT w/ exceptions if field has no
HAS_MAXCONCURRENTCOUNT()	Determine if MAXCONCURRENTCOUNT has a value

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.

Accessible with the following methods

Method	Description
GET_MAXCONCURRENTPERCENTAGE()	Getter for MAXCONCURRENTPERCENTAGE, with configurable defaul
ASK_MAXCONCURRENTPERCENTAGE()	Getter for MAXCONCURRENTPERCENTAGE w/ exceptions if field ha
HAS_MAXCONCURRENTPERCENTAGE()	Determine if MAXCONCURRENTPERCENTAGE has a value

ConcurrencyMode

Specifies how the concurrency level behaves during the operation execution.

• STRICT_FAILURE_TOLERANCE: This option dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the value of FailureToleranceCount +1. The initial actual concurrency is set to the lower of either the value of the MaxConcurrentCount, or the value of FailureToleranceCount +1. The actual concurrency is then reduced proportionally by the number of failures. This is the default behavior.

  If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.

• SOFT_FAILURE_TOLERANCE: This option decouples FailureToleranceCount from the actual concurrency. This allows stack set operations to run at the concurrency level set by the MaxConcurrentCount value, or MaxConcurrentPercentage, regardless of the number of failures.

Accessible with the following methods

Method	Description
GET_CONCURRENCYMODE()	Getter for CONCURRENCYMODE, with configurable default
ASK_CONCURRENCYMODE()	Getter for CONCURRENCYMODE w/ exceptions if field has no val
HAS_CONCURRENCYMODE()	Determine if CONCURRENCYMODE has a value