CfnDeploymentPropsMixin

class aws_cdk.mixins_preview.aws_appconfig.mixins.CfnDeploymentPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::AppConfig::Deployment resource starts a deployment.

Starting a deployment in AWS AppConfig calls the StartDeployment API action. This call includes the IDs of the AWS AppConfig application, the environment, the configuration profile, and (optionally) the configuration data version to deploy. The call also includes the ID of the deployment strategy to use, which determines how the configuration data is deployed.

AWS AppConfig monitors the distribution to all hosts and reports status. If a distribution fails, then AWS AppConfig rolls back the configuration.

AWS AppConfig requires that you create resources and deploy a configuration in the following order:

Create an application
Create an environment
Create a configuration profile
Choose a pre-defined deployment strategy or create your own
Deploy the configuration

For more information, see AWS AppConfig in the AWS AppConfig User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html
CloudformationResource:: AWS::AppConfig::Deployment
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_appconfig import mixins as appconfig_mixins

cfn_deployment_props_mixin = appconfig_mixins.CfnDeploymentPropsMixin(appconfig_mixins.CfnDeploymentMixinProps(
    application_id="applicationId",
    configuration_profile_id="configurationProfileId",
    configuration_version="configurationVersion",
    deployment_strategy_id="deploymentStrategyId",
    description="description",
    dynamic_extension_parameters=[appconfig_mixins.CfnDeploymentPropsMixin.DynamicExtensionParametersProperty(
        extension_reference="extensionReference",
        parameter_name="parameterName",
        parameter_value="parameterValue"
    )],
    environment_id="environmentId",
    kms_key_identifier="kmsKeyIdentifier",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::AppConfig::Deployment.

Parameters:

props (Union[CfnDeploymentMixinProps, 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 = ['applicationId', 'configurationProfileId', 'configurationVersion', 'deploymentStrategyId', 'description', 'dynamicExtensionParameters', 'environmentId', 'kmsKeyIdentifier', '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

DynamicExtensionParametersProperty

class CfnDeploymentPropsMixin.DynamicExtensionParametersProperty(*, extension_reference=None, parameter_name=None, parameter_value=None)

Bases: object

A map of dynamic extension parameter names to values to pass to associated extensions with PRE_START_DEPLOYMENT actions.

Parameters:

extension_reference (Optional[str]) – The ARN or ID of the extension for which you are inserting a dynamic parameter.
parameter_name (Optional[str]) – The parameter name.
parameter_value (Optional[str]) – The parameter value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-dynamicextensionparameters.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_appconfig import mixins as appconfig_mixins

dynamic_extension_parameters_property = appconfig_mixins.CfnDeploymentPropsMixin.DynamicExtensionParametersProperty(
    extension_reference="extensionReference",
    parameter_name="parameterName",
    parameter_value="parameterValue"
)

Attributes

extension_reference

The ARN or ID of the extension for which you are inserting a dynamic parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-dynamicextensionparameters.html#cfn-appconfig-deployment-dynamicextensionparameters-extensionreference

parameter_name

The parameter name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-dynamicextensionparameters.html#cfn-appconfig-deployment-dynamicextensionparameters-parametername

parameter_value

The parameter value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-dynamicextensionparameters.html#cfn-appconfig-deployment-dynamicextensionparameters-parametervalue