CfnDeploymentProps

class aws_cdk.aws_appconfig.CfnDeploymentProps(*, application_id, configuration_profile_id, configuration_version, deployment_strategy_id, environment_id, description=None, kms_key_identifier=None, tags=None)

Bases: object

Properties for defining a CfnDeployment.

Parameters:
  • application_id (str) – The application ID.

  • configuration_profile_id (str) – The configuration profile ID.

  • configuration_version (str) – The configuration version to deploy. If deploying an AWS AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number.

  • deployment_strategy_id (str) – The deployment strategy ID.

  • environment_id (str) – The environment ID.

  • description (Optional[str]) – A description of the deployment.

  • kms_key_identifier (Optional[str]) – The AWS KMS key identifier (key ID, key alias, or key ARN). AWS AppConfig uses this ID to encrypt the configuration data using a customer managed key.

  • tags (Optional[Sequence[Union[TagsProperty, Dict[str, Any]]]]) – Metadata to assign to the deployment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_appconfig as appconfig

cfn_deployment_props = appconfig.CfnDeploymentProps(
    application_id="applicationId",
    configuration_profile_id="configurationProfileId",
    configuration_version="configurationVersion",
    deployment_strategy_id="deploymentStrategyId",
    environment_id="environmentId",

    # the properties below are optional
    description="description",
    kms_key_identifier="kmsKeyIdentifier",
    tags=[appconfig.CfnDeployment.TagsProperty(
        key="key",
        value="value"
    )]
)

Attributes

application_id

The application ID.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-applicationid

configuration_profile_id

The configuration profile ID.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-configurationprofileid

configuration_version

The configuration version to deploy.

If deploying an AWS AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-configurationversion

deployment_strategy_id

The deployment strategy ID.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-deploymentstrategyid

description

A description of the deployment.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-description

environment_id

The environment ID.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-environmentid

kms_key_identifier

The AWS KMS key identifier (key ID, key alias, or key ARN).

AWS AppConfig uses this ID to encrypt the configuration data using a customer managed key.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-kmskeyidentifier

tags

Metadata to assign to the deployment.

Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-deployment.html#cfn-appconfig-deployment-tags