aws-cdk-lib.cx_api.Environment

Environment Struct

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

Source

cx-api/lib/legacy-moved.ts

Type last changed

v2.238.0 · 9 Feb 2026

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

accountstringaccountstraccountStringAccountstringAccount*stringrequired#

The AWS account this environment deploys into.

namestringnamestrnameStringNamestringName*stringrequired#

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

regionstringregionstrregionStringRegionstringRegion*stringrequired#

The AWS region name where this environment deploys into.