Package software.amazon.awscdk

Interface Environment

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

Environment.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:02.180Z")
@Stability(Stable)
public interface Environment
extends software.amazon.jsii.JsiiSerializable

The deployment environment for a stack.

Example:

 import software.amazon.awscdk.*;
 App app = new App();
 Stack stack = Stack.Builder.create(app, "Stack").env(Environment.builder().region("us-west-2").build()).build();
 TableV2 globalTable = TableV2.Builder.create(stack, "GlobalTable")
         .partitionKey(Attribute.builder().name("pk").type(AttributeType.STRING).build())
         .replicas(List.of(ReplicaTableProps.builder().region("us-east-1").build()))
         .build();
 globalTable.addReplica(ReplicaTableProps.builder().region("us-east-2").deletionProtection(true).build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	Environment.Builder	A builder for Environment
static final class	Environment.Jsii$Proxy	An implementation for Environment

Method Summary

Modifier and Type	Method	Description
static Environment.Builder	builder()
default String	getAccount()	The AWS account ID for this environment.
default String	getRegion()	The AWS region for this environment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccount

@Stability(Stable)
@Nullable
default String getAccount()

The AWS account ID for this environment.

This can be either a concrete value such as 585191031104 or Aws.ACCOUNT_ID which indicates that account ID will only be determined during deployment (it will resolve to the CloudFormation intrinsic {"Ref":"AWS::AccountId"}). Note that certain features, such as cross-stack references and environmental context providers require concrete region information and will cause this stack to emit synthesis errors.

Default: Aws.ACCOUNT_ID which means that the stack will be account-agnostic.

getRegion

@Stability(Stable)
@Nullable
default String getRegion()

The AWS region for this environment.

This can be either a concrete value such as eu-west-2 or Aws.REGION which indicates that account ID will only be determined during deployment (it will resolve to the CloudFormation intrinsic {"Ref":"AWS::Region"}). Note that certain features, such as cross-stack references and environmental context providers require concrete region information and will cause this stack to emit synthesis errors.

Default: Aws.REGION which means that the stack will be region-agnostic.

builder

@Stability(Stable)
static Environment.Builder builder()

Returns:

a Environment.Builder of Environment