Class CfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty
The user-defined preferences that will be applied when updating a provisioned product.
Inheritance
Namespace: Amazon.CDK.AWS.ServiceCatalog
Assembly: Amazon.CDK.AWS.ServiceCatalog.dll
Syntax (csharp)
public class ProvisioningPreferencesProperty : Object, CfnCloudFormationProvisionedProduct.IProvisioningPreferencesProperty
Syntax (vb)
Public Class ProvisioningPreferencesProperty
Inherits Object
Implements CfnCloudFormationProvisionedProduct.IProvisioningPreferencesProperty
Remarks
Not all preferences are applicable to all provisioned product type
One or more AWS accounts that will have access to the provisioned product.
Applicable only to a CFN_STACKSET
provisioned product type.
The AWS 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.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ServiceCatalog;
var provisioningPreferencesProperty = new ProvisioningPreferencesProperty {
StackSetAccounts = new [] { "stackSetAccounts" },
StackSetFailureToleranceCount = 123,
StackSetFailureTolerancePercentage = 123,
StackSetMaxConcurrencyCount = 123,
StackSetMaxConcurrencyPercentage = 123,
StackSetOperationType = "stackSetOperationType",
StackSetRegions = new [] { "stackSetRegions" }
};
Synopsis
Constructors
ProvisioningPreferencesProperty() |
Properties
StackSetAccounts | One or more AWS accounts where the provisioned product will be available. |
StackSetFailureToleranceCount | The number of accounts, per Region, for which this operation can fail before AWS Service Catalog stops the operation in that Region. |
StackSetFailureTolerancePercentage | The percentage of accounts, per Region, for which this stack operation can fail before AWS Service Catalog stops the operation in that Region. |
StackSetMaxConcurrencyCount | The maximum number of accounts in which to perform this operation at one time. |
StackSetMaxConcurrencyPercentage | The maximum percentage of accounts in which to perform this operation at one time. |
StackSetOperationType | Determines what action AWS Service Catalog performs to a stack set or a stack instance represented by the provisioned product. |
StackSetRegions | One or more AWS Regions where the provisioned product will be available. |
Constructors
ProvisioningPreferencesProperty()
public ProvisioningPreferencesProperty()
Properties
StackSetAccounts
One or more AWS accounts where the provisioned product will be available.
public string[] StackSetAccounts { get; set; }
Property Value
System.String[]
Remarks
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 the STACKSET
constraint, use the DescribeProvisioningParameters
operation.
If no values are specified, the default value is all acounts from the STACKSET
constraint.
StackSetFailureToleranceCount
The number of accounts, per Region, for which this operation can fail before AWS Service Catalog stops the operation in that Region.
public Nullable<double> StackSetFailureToleranceCount { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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
or StackSetFailureTolerancePercentage
, but not both.
The default value is 0
if no value is specified.
StackSetFailureTolerancePercentage
The percentage of accounts, per Region, for which this stack operation can fail before AWS Service Catalog stops the operation in that Region.
public Nullable<double> StackSetFailureTolerancePercentage { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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
or StackSetFailureTolerancePercentage
, but not both.
StackSetMaxConcurrencyCount
The maximum number of accounts in which to perform this operation at one time.
public Nullable<double> StackSetMaxConcurrencyCount { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
This is dependent on the value of StackSetFailureToleranceCount
. StackSetMaxConcurrentCount
is at most one more than the StackSetFailureToleranceCount
.
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
or StackSetMaxConcurrentPercentage
, but not both.
StackSetMaxConcurrencyPercentage
The maximum percentage of accounts in which to perform this operation at one time.
public Nullable<double> StackSetMaxConcurrencyPercentage { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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 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
or StackSetMaxConcurrentPercentage
, but not both.
StackSetOperationType
Determines what action AWS Service Catalog performs to a stack set or a stack instance represented by the provisioned product.
public string StackSetOperationType { get; set; }
Property Value
System.String
Remarks
The default value is UPDATE
if nothing is specified.
Applicable only to a CFN_STACKSET
provisioned product type.
StackSetRegions
One or more AWS Regions where the provisioned product will be available.
public string[] StackSetRegions { get; set; }
Property Value
System.String[]
Remarks
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 the STACKSET
constraint, use the DescribeProvisioningParameters
operation.
If no values are specified, the default value is all Regions from the STACKSET
constraint.