Environment Struct
The deployment environment for a stack.
| Source | core/lib/environment.ts |
|---|---|
| Type last changed |
Example
const stack1 = new Stack(app, 'Stack1', {
env: {
region: 'us-east-1',
},
});
const cert = new acm.Certificate(stack1, 'Cert', {
domainName: '*.example.com',
validation: acm.CertificateValidation.fromDns(route53.PublicHostedZone.fromHostedZoneId(stack1, 'Zone', 'Z0329774B51CGXTDQV3X')),
});
const stack2 = new Stack(app, 'Stack2', {
env: {
region: 'us-east-2',
},
});
new cloudfront.Distribution(stack2, 'Distribution', {
defaultBehavior: {
origin: new origins.HttpOrigin('example.com'),
},
domainNames: ['dev.example.com'],
certificate: cert,
});
from aws_cdk import Environment, Environment
stack1 = Stack(app, "Stack1",
env=Environment(
region="us-east-1"
)
)
cert = acm.Certificate(stack1, "Cert",
domain_name="*.example.com",
validation=acm.CertificateValidation.from_dns(route53.PublicHostedZone.from_hosted_zone_id(stack1, "Zone", "Z0329774B51CGXTDQV3X"))
)
stack2 = Stack(app, "Stack2",
env=Environment(
region="us-east-2"
)
)
cloudfront.Distribution(stack2, "Distribution",
default_behavior=cloudfront.BehaviorOptions(
origin=origins.HttpOrigin("example.com")
),
domain_names=["dev.example.com"],
certificate=cert
)
Stack stack1 = Stack.Builder.create(app, "Stack1")
.env(Environment.builder()
.region("us-east-1")
.build())
.build();
Certificate cert = Certificate.Builder.create(stack1, "Cert")
.domainName("*.example.com")
.validation(CertificateValidation.fromDns(PublicHostedZone.fromHostedZoneId(stack1, "Zone", "Z0329774B51CGXTDQV3X")))
.build();
Stack stack2 = Stack.Builder.create(app, "Stack2")
.env(Environment.builder()
.region("us-east-2")
.build())
.build();
Distribution.Builder.create(stack2, "Distribution")
.defaultBehavior(BehaviorOptions.builder()
.origin(new HttpOrigin("example.com"))
.build())
.domainNames(List.of("dev.example.com"))
.certificate(cert)
.build();
// Install: dotnet add package Amazon.CDK.Lib
var stack1 = new Stack(app, "Stack1", new StackProps {
Env = new Environment {
Region = "us-east-1"
}
});
var cert = new Certificate(stack1, "Cert", new CertificateProps {
DomainName = "*.example.com",
Validation = CertificateValidation.FromDns(PublicHostedZone.FromHostedZoneId(stack1, "Zone", "Z0329774B51CGXTDQV3X"))
});
var stack2 = new Stack(app, "Stack2", new StackProps {
Env = new Environment {
Region = "us-east-2"
}
});
new Distribution(stack2, "Distribution", new DistributionProps {
DefaultBehavior = new BehaviorOptions {
Origin = new HttpOrigin("example.com")
},
DomainNames = new [] { "dev.example.com" },
Certificate = cert
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
stack1 := awscdk.Newstack(app, jsii.String("Stack1"), &StackProps{
Env: &Environment{
Region: jsii.String("us-east-1"),
},
})
cert := acm.NewCertificate(stack1, jsii.String("Cert"), &CertificateProps{
DomainName: jsii.String("*.example.com"),
Validation: acm.CertificateValidation_FromDns(route53.PublicHostedZone_FromHostedZoneId(stack1, jsii.String("Zone"), jsii.String("Z0329774B51CGXTDQV3X"))),
})
stack2 := awscdk.Newstack(app, jsii.String("Stack2"), &StackProps{
Env: &Environment{
Region: jsii.String("us-east-2"),
},
})
cloudfront.NewDistribution(stack2, jsii.String("Distribution"), &DistributionProps{
DefaultBehavior: &BehaviorOptions{
Origin: origins.NewHttpOrigin(jsii.String("example.com")),
},
DomainNames: []*string{
jsii.String("dev.example.com"),
},
Certificate: cert,
})
Properties
accountoptionalstringaccountoptionalstraccountoptionalStringAccountoptionalstringAccountoptional*string #Default: Aws.ACCOUNT_ID which means that the stack will be account-agnostic.
notes
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.
regionoptionalstringregionoptionalstrregionoptionalStringRegionoptionalstringRegionoptional*string #Default: Aws.REGION which means that the stack will be region-agnostic.
notes
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.