UNPKG

1.36 kBTypeScriptView Raw
1/**
2 * The deployment environment for a stack.
3 */
4export interface Environment {
5 /**
6 * The AWS account ID for this environment.
7 *
8 * This can be either a concrete value such as `585191031104` or `Aws.accountId` which
9 * indicates that account ID will only be determined during deployment (it
10 * will resolve to the CloudFormation intrinsic `{"Ref":"AWS::AccountId"}`).
11 * Note that certain features, such as cross-stack references and
12 * environmental context providers require concerete region information and
13 * will cause this stack to emit synthesis errors.
14 *
15 * @default Aws.accountId which means that the stack will be account-agnostic.
16 */
17 readonly account?: string;
18 /**
19 * The AWS region for this environment.
20 *
21 * This can be either a concrete value such as `eu-west-2` or `Aws.region`
22 * which indicates that account ID will only be determined during deployment
23 * (it will resolve to the CloudFormation intrinsic `{"Ref":"AWS::Region"}`).
24 * Note that certain features, such as cross-stack references and
25 * environmental context providers require concerete region information and
26 * will cause this stack to emit synthesis errors.
27 *
28 * @default Aws.region which means that the stack will be region-agnostic.
29 */
30 readonly region?: string;
31}