aws-cdk-lib.aws_appconfig.CfnEnvironmentProps

interface CfnEnvironmentProps

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

Properties for defining a CfnEnvironment.

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 cfnEnvironmentProps: appconfig.CfnEnvironmentProps = {
  applicationId: 'applicationId',
  name: 'name',

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

Properties

NameTypeDescription
applicationIdstringThe application ID.
namestringA name for the environment.
description?stringA description of the environment.
monitors?IResolvable | IResolvable | MonitorsProperty[]Amazon CloudWatch alarms to monitor during the deployment process.
tags?TagsProperty[]Metadata to assign to the environment.

applicationId

Type: string

The application ID.


name

Type: string

A name for the environment.


description?

Type: string (optional)

A description of the environment.


monitors?

Type: IResolvable | IResolvable | MonitorsProperty[] (optional)

Amazon CloudWatch alarms to monitor during the deployment process.


tags?

Type: TagsProperty[] (optional)

Metadata to assign to the environment.

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