aws-cdk-lib.aws_appconfig.CfnDeploymentProps

interface CfnDeploymentProps

LanguageType name
.NETAmazon.CDK.AWS.AppConfig.CfnDeploymentProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappconfig#CfnDeploymentProps
Javasoftware.amazon.awscdk.services.appconfig.CfnDeploymentProps
Pythonaws_cdk.aws_appconfig.CfnDeploymentProps
TypeScript aws-cdk-lib » aws_appconfig » CfnDeploymentProps

Properties for defining a CfnDeployment.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appconfig as appconfig } from 'aws-cdk-lib';
const cfnDeploymentProps: appconfig.CfnDeploymentProps = {
  applicationId: 'applicationId',
  configurationProfileId: 'configurationProfileId',
  configurationVersion: 'configurationVersion',
  deploymentStrategyId: 'deploymentStrategyId',
  environmentId: 'environmentId',

  // the properties below are optional
  description: 'description',
  kmsKeyIdentifier: 'kmsKeyIdentifier',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
applicationIdstringThe application ID.
configurationProfileIdstringThe configuration profile ID.
configurationVersionstringThe configuration version to deploy.
deploymentStrategyIdstringThe deployment strategy ID.
environmentIdstringThe environment ID.
description?stringA description of the deployment.
kmsKeyIdentifier?stringThe AWS KMS key identifier (key ID, key alias, or key ARN).
tags?TagsProperty[]Metadata to assign to the deployment.

applicationId

Type: string

The application ID.


configurationProfileId

Type: string

The configuration profile ID.


configurationVersion

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


deploymentStrategyId

Type: string

The deployment strategy ID.


environmentId

Type: string

The environment ID.


description?

Type: string (optional)

A description of the deployment.


kmsKeyIdentifier?

Type: string (optional)

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?

Type: TagsProperty[] (optional)

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.