AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::AppConfig::Deployment

CfnDeployment

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](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the *AWS AppConfig User Guide* .

Import

import { CfnDeployment } from 'aws-cdk-lib/aws-appconfig';

Or use the module namespace:

import * as appconfig from 'aws-cdk-lib/aws-appconfig';
// appconfig.CfnDeployment

Properties

Configuration passed to the constructor as CfnDeploymentProps.

applicationIdRequired
string

The application ID.

configurationProfileIdRequired
string

The configuration profile ID.

configurationVersionRequired
string

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.

deploymentStrategyIdRequired
string

The deployment strategy ID.

environmentIdRequired
string

The environment ID.

descriptionOptional
string

A description of the deployment.

dynamicExtensionParametersOptional
IResolvable | IResolvable | DynamicExtensionParametersProperty[]

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

kmsKeyIdentifierOptional
string

The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

tagsOptional
CfnTag[]

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.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::AppConfig::DeploymentView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-appconfig
CFN TypeAWS::AppConfig::Deployment
Properties9

Related Constructs

Explore This Service

External Links