AWS::ServiceCatalog::CloudFormationProvisionedProduct ProvisioningPreferences
The user-defined preferences that will be applied when updating a provisioned product. Not all preferences are applicable to all provisioned product type
One or more Amazon Web Services accounts that will have access to the provisioned product.
Applicable only to a CFN_STACKSET
provisioned product type.
The Amazon Web Services accounts specified should be within the list of accounts in the
STACKSET
constraint. To get the list of accounts in the
STACKSET
constraint, use the DescribeProvisioningParameters
operation.
If no values are specified, the default value is all accounts from the
STACKSET
constraint.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "StackSetAccounts" :
[ String, ... ]
, "StackSetFailureToleranceCount" :Integer
, "StackSetFailureTolerancePercentage" :Integer
, "StackSetMaxConcurrencyCount" :Integer
, "StackSetMaxConcurrencyPercentage" :Integer
, "StackSetOperationType" :String
, "StackSetRegions" :[ String, ... ]
}
YAML
StackSetAccounts:
- String
StackSetFailureToleranceCount:Integer
StackSetFailureTolerancePercentage:Integer
StackSetMaxConcurrencyCount:Integer
StackSetMaxConcurrencyPercentage:Integer
StackSetOperationType:String
StackSetRegions:- String
Properties
StackSetAccounts
-
One or more Amazon Web Services accounts where the provisioned product will be available.
Applicable only to a
CFN_STACKSET
provisioned product type.The specified accounts should be within the list of accounts from the
STACKSET
constraint. To get the list of accounts in theSTACKSET
constraint, use theDescribeProvisioningParameters
operation.If no values are specified, the default value is all acounts from the
STACKSET
constraint.Required: No
Type: Array of String
Update requires: No interruption
StackSetFailureToleranceCount
-
The number of accounts, per Region, for which this operation can fail before Amazon Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Amazon Service Catalog doesn't attempt the operation in any subsequent Regions.
Applicable only to a
CFN_STACKSET
provisioned product type.Conditional: You must specify either
StackSetFailureToleranceCount
orStackSetFailureTolerancePercentage
, but not both.The default value is
0
if no value is specified.Required: No
Type: Integer
Minimum:
0
Update requires: No interruption
StackSetFailureTolerancePercentage
-
The percentage of accounts, per Region, for which this stack operation can fail before Amazon Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Amazon Service Catalog doesn't attempt the operation in any subsequent Regions.
When calculating the number of accounts based on the specified percentage, Amazon Service Catalog rounds down to the next whole number.
Applicable only to a
CFN_STACKSET
provisioned product type.Conditional: You must specify either
StackSetFailureToleranceCount
orStackSetFailureTolerancePercentage
, but not both.Required: No
Type: Integer
Minimum:
0
Maximum:
100
Update requires: No interruption
StackSetMaxConcurrencyCount
-
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of
StackSetFailureToleranceCount
.StackSetMaxConcurrentCount
is at most one more than theStackSetFailureToleranceCount
.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.
Applicable only to a
CFN_STACKSET
provisioned product type.Conditional: You must specify either
StackSetMaxConcurrentCount
orStackSetMaxConcurrentPercentage
, but not both.Required: No
Type: Integer
Minimum:
1
Update requires: No interruption
StackSetMaxConcurrencyPercentage
-
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, Amazon Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, Amazon Service Catalog sets the number as
1
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.
Applicable only to a
CFN_STACKSET
provisioned product type.Conditional: You must specify either
StackSetMaxConcurrentCount
orStackSetMaxConcurrentPercentage
, but not both.Required: No
Type: Integer
Minimum:
1
Maximum:
100
Update requires: No interruption
StackSetOperationType
-
Determines what action Amazon Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is
UPDATE
if nothing is specified.Applicable only to a
CFN_STACKSET
provisioned product type.- CREATE
-
Creates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and Regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored.
- UPDATE
-
Updates the stack set represented by the provisioned product and also its stack instances.
- DELETE
-
Deletes a stack instance in the stack set represented by the provisioned product.
Required: No
Type: String
Allowed values:
CREATE | UPDATE | DELETE
Update requires: No interruption
StackSetRegions
-
One or more Amazon Web Services Regions where the provisioned product will be available.
Applicable only to a
CFN_STACKSET
provisioned product type.The specified Regions should be within the list of Regions from the
STACKSET
constraint. To get the list of Regions in theSTACKSET
constraint, use theDescribeProvisioningParameters
operation.If no values are specified, the default value is all Regions from the
STACKSET
constraint.Required: No
Type: Array of String
Update requires: No interruption