@aws-cdk_cx-api.Environment

interface Environment

LanguageType name
.NETAmazon.CDK.CXAPI.Environment
Javasoftware.amazon.awscdk.cxapi.Environment
Pythonaws_cdk.cx_api.Environment
TypeScript (source)@aws-cdk/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 * as cx_api from '@aws-cdk/cx-api';
const environment: cx_api.Environment = {
  account: 'account',
  name: 'name',
  region: 'region',
};

Properties

NameTypeDescription
accountstringThe AWS account this environment deploys into.
namestringThe arbitrary name of this environment (user-set, or at least user-meaningful).
regionstringThe 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.