interface Environment

Language	Type name
.NET	Amazon.CDK.CXAPI.Environment
Go	github.com/aws/aws-cdk-go/awscdk/v2/cxapi#Environment
Java	software.amazon.awscdk.cxapi.Environment
Python	aws_cdk.cx_api.Environment
TypeScript (source)	aws-cdk-lib » cx_api » Environment

Obtainable from EnvironmentUtils.make(), EnvironmentUtils.parse()

Models an AWS execution environment, for use within the CDK toolkit.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { cx_api } from 'aws-cdk-lib';
const environment: cx_api.Environment = {
  account: 'account',
  name: 'name',
  region: 'region',
};

Properties

Name	Type	Description
account	string	The AWS account this environment deploys into.
name	string	The arbitrary name of this environment (user-set, or at least user-meaningful).
region	string	The AWS region name where this environment deploys into.

---

account

Type: string

The AWS account this environment deploys into.

---

name

Type: string

The arbitrary name of this environment (user-set, or at least user-meaningful).

---

region

Type: string

The AWS region name where this environment deploys into.