Class CfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty>
- Enclosing interface:
CfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.stackSetAccounts
(List<String> stackSetAccounts) stackSetFailureToleranceCount
(Number stackSetFailureToleranceCount) stackSetFailureTolerancePercentage
(Number stackSetFailureTolerancePercentage) stackSetMaxConcurrencyCount
(Number stackSetMaxConcurrencyCount) stackSetMaxConcurrencyPercentage
(Number stackSetMaxConcurrencyPercentage) stackSetOperationType
(String stackSetOperationType) stackSetRegions
(List<String> stackSetRegions)
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
stackSetAccounts
@Stability(Stable) public CfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty.Builder stackSetAccounts(List<String> stackSetAccounts) Sets the value ofCfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty.getStackSetAccounts()
- Parameters:
stackSetAccounts
- One or more AWS accounts where the provisioned product will be available. Applicable only to aCFN_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.- Returns:
this
-
stackSetFailureToleranceCount
@Stability(Stable) public CfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty.Builder stackSetFailureToleranceCount(Number stackSetFailureToleranceCount) Sets the value ofCfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty.getStackSetFailureToleranceCount()
- Parameters:
stackSetFailureToleranceCount
- The number of accounts, per Region, for which this operation can fail before AWS Service Catalog stops the operation in that Region. If the operation is stopped in a Region, AWS 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.- Returns:
this
-
stackSetFailureTolerancePercentage
@Stability(Stable) public CfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty.Builder stackSetFailureTolerancePercentage(Number stackSetFailureTolerancePercentage) Sets the value ofCfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty.getStackSetFailureTolerancePercentage()
- Parameters:
stackSetFailureTolerancePercentage
- The percentage of accounts, per Region, for which this stack operation can fail before AWS Service Catalog stops the operation in that Region. If the operation is stopped in a Region, AWS Service Catalog doesn't attempt the operation in any subsequent Regions.When calculating the number of accounts based on the specified percentage, AWS 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.- Returns:
this
-
stackSetMaxConcurrencyCount
@Stability(Stable) public CfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty.Builder stackSetMaxConcurrencyCount(Number stackSetMaxConcurrencyCount) Sets the value ofCfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty.getStackSetMaxConcurrencyCount()
- Parameters:
stackSetMaxConcurrencyCount
- The maximum number of accounts in which to perform this operation at one time. This is dependent on the value ofStackSetFailureToleranceCount
.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.- Returns:
this
-
stackSetMaxConcurrencyPercentage
@Stability(Stable) public CfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty.Builder stackSetMaxConcurrencyPercentage(Number stackSetMaxConcurrencyPercentage) Sets the value ofCfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty.getStackSetMaxConcurrencyPercentage()
- Parameters:
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, AWS 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, AWS Service Catalog sets the number as1
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.- Returns:
this
-
stackSetOperationType
@Stability(Stable) public CfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty.Builder stackSetOperationType(String stackSetOperationType) Sets the value ofCfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty.getStackSetOperationType()
- Parameters:
stackSetOperationType
- Determines what action AWS Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value isUPDATE
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.
- Returns:
this
-
stackSetRegions
@Stability(Stable) public CfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty.Builder stackSetRegions(List<String> stackSetRegions) Sets the value ofCfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty.getStackSetRegions()
- Parameters:
stackSetRegions
- One or more AWS Regions where the provisioned product will be available. Applicable only to aCFN_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.- Returns:
this
-
build
@Stability(Stable) public CfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty build()Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty>
- Returns:
- a new instance of
CfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-