CfnCloudFormationProvisionedProductPropsMixin

class aws_cdk.mixins_preview.aws_servicecatalog.mixins.CfnCloudFormationProvisionedProductPropsMixin(props, *, strategy=None)

Bases: Mixin

Provisions the specified product.

A provisioned product is a resourced instance of a product. For example, provisioning a product based on a AWS CloudFormation template launches a AWS CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord .

If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error “Parameter validation failed: Missing required parameter in Tags[ N ]: Value “.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html
CloudformationResource:: AWS::ServiceCatalog::CloudFormationProvisionedProduct
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_servicecatalog import mixins as servicecatalog_mixins

cfn_cloud_formation_provisioned_product_props_mixin = servicecatalog_mixins.CfnCloudFormationProvisionedProductPropsMixin(servicecatalog_mixins.CfnCloudFormationProvisionedProductMixinProps(
    accept_language="acceptLanguage",
    notification_arns=["notificationArns"],
    path_id="pathId",
    path_name="pathName",
    product_id="productId",
    product_name="productName",
    provisioned_product_name="provisionedProductName",
    provisioning_artifact_id="provisioningArtifactId",
    provisioning_artifact_name="provisioningArtifactName",
    provisioning_parameters=[servicecatalog_mixins.CfnCloudFormationProvisionedProductPropsMixin.ProvisioningParameterProperty(
        key="key",
        value="value"
    )],
    provisioning_preferences=servicecatalog_mixins.CfnCloudFormationProvisionedProductPropsMixin.ProvisioningPreferencesProperty(
        stack_set_accounts=["stackSetAccounts"],
        stack_set_failure_tolerance_count=123,
        stack_set_failure_tolerance_percentage=123,
        stack_set_max_concurrency_count=123,
        stack_set_max_concurrency_percentage=123,
        stack_set_operation_type="stackSetOperationType",
        stack_set_regions=["stackSetRegions"]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ServiceCatalog::CloudFormationProvisionedProduct.

Parameters:

props (Union[CfnCloudFormationProvisionedProductMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['acceptLanguage', 'notificationArns', 'pathId', 'pathName', 'productId', 'productName', 'provisionedProductName', 'provisioningArtifactId', 'provisioningArtifactName', 'provisioningParameters', 'provisioningPreferences', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ProvisioningParameterProperty

class CfnCloudFormationProvisionedProductPropsMixin.ProvisioningParameterProperty(*, key=None, value=None)

Bases: object

Information about a parameter used to provision a product.

Parameters:

key (Optional[str]) – The parameter key.
value (Optional[str]) – The parameter value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningparameter.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_servicecatalog import mixins as servicecatalog_mixins

provisioning_parameter_property = servicecatalog_mixins.CfnCloudFormationProvisionedProductPropsMixin.ProvisioningParameterProperty(
    key="key",
    value="value"
)

Attributes

key

The parameter key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningparameter.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningparameter-key

value

The parameter value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningparameter.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningparameter-value

ProvisioningPreferencesProperty

class CfnCloudFormationProvisionedProductPropsMixin.ProvisioningPreferencesProperty(*, stack_set_accounts=None, stack_set_failure_tolerance_count=None, stack_set_failure_tolerance_percentage=None, stack_set_max_concurrency_count=None, stack_set_max_concurrency_percentage=None, stack_set_operation_type=None, stack_set_regions=None)

Bases: object

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

Parameters:

stack_set_accounts (Optional[Sequence[str]]) – One or more AWS 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 the STACKSET constraint, use the DescribeProvisioningParameters operation. If no values are specified, the default value is all acounts from the STACKSET constraint.
stack_set_failure_tolerance_count (Union[int, float, None]) – 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 or StackSetFailureTolerancePercentage , but not both. The default value is 0 if no value is specified.
stack_set_failure_tolerance_percentage (Union[int, float, None]) – 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 or StackSetFailureTolerancePercentage , but not both.
stack_set_max_concurrency_count (Union[int, float, None]) – 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 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.
stack_set_max_concurrency_percentage (Union[int, float, None]) – 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 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.
stack_set_operation_type (Optional[str]) – Determines what action AWS 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.
stack_set_regions (Optional[Sequence[str]]) – One or more AWS 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 the STACKSET constraint, use the DescribeProvisioningParameters operation. If no values are specified, the default value is all Regions from the STACKSET constraint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_servicecatalog import mixins as servicecatalog_mixins

provisioning_preferences_property = servicecatalog_mixins.CfnCloudFormationProvisionedProductPropsMixin.ProvisioningPreferencesProperty(
    stack_set_accounts=["stackSetAccounts"],
    stack_set_failure_tolerance_count=123,
    stack_set_failure_tolerance_percentage=123,
    stack_set_max_concurrency_count=123,
    stack_set_max_concurrency_percentage=123,
    stack_set_operation_type="stackSetOperationType",
    stack_set_regions=["stackSetRegions"]
)

Attributes

stack_set_accounts

One or more AWS 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 the STACKSET constraint, use the DescribeProvisioningParameters operation.

If no values are specified, the default value is all acounts from the STACKSET constraint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences-stacksetaccounts

stack_set_failure_tolerance_count

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 or StackSetFailureTolerancePercentage , but not both.

The default value is 0 if no value is specified.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences-stacksetfailuretolerancecount

stack_set_failure_tolerance_percentage

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 or StackSetFailureTolerancePercentage , but not both.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences-stacksetfailuretolerancepercentage

stack_set_max_concurrency_count

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences-stacksetmaxconcurrencycount

stack_set_max_concurrency_percentage

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences-stacksetmaxconcurrencypercentage

stack_set_operation_type

Determines what action AWS 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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences-stacksetoperationtype

stack_set_regions

One or more AWS 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 the STACKSET constraint, use the DescribeProvisioningParameters operation.

If no values are specified, the default value is all Regions from the STACKSET constraint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences-stacksetregions