Class StackProps
public class StackProps : IStackProps- Inheritance
-
StackProps
- Implements
- Inherited Members
Examples
class StackUnderTestProps : StackProps
{
public Architecture? Architecture { get; set; }
}
class StackUnderTest : Stack
{
public StackUnderTest(Construct scope, string id, StackUnderTestProps props) : base(scope, id, props)
{
new Function(this, "Handler", new FunctionProps {
Runtime = Runtime.NODEJS_14_X,
Handler = "index.handler",
Code = Code.FromAsset(Join(__dirname, "lambda-handler")),
Architecture = props.Architecture
});
}
}
// Beginning of the test suite
var app = new App();
new IntegTest(app, "DifferentArchitectures", new IntegTestProps {
TestCases = new [] {
new StackUnderTest(app, "Stack1", new StackUnderTestProps {
Architecture = Architecture.ARM_64
}),
new StackUnderTest(app, "Stack2", new StackUnderTestProps {
Architecture = Architecture.X86_64
}) }
});Remarks
ExampleMetadata: infused
Constructors
StackProps()
public StackProps()Properties
AnalyticsReporting
Include runtime versioning information in this Stack.
public bool? AnalyticsReporting { get; set; }Property Value
- bool?
Remarks
Default: analyticsReporting setting of containing App, or value of
'aws:cdk:version-reporting' context key
Description
A description of the stack.
public string? Description { get; set; }Property Value
Remarks
Default: - No description.
Env
The AWS environment (account/region) where this stack will be deployed.
public IEnvironment? Env { get; set; }Property Value
Examples
// Use a concrete account and region to deploy this stack to:
// `.account` and `.region` will simply return these values.
// Use a concrete account and region to deploy this stack to:
// `.account` and `.region` will simply return these values.
new Stack(app, "Stack1", new StackProps {
Env = new Environment {
Account = "123456789012",
Region = "us-east-1"
}
});
// Use the CLI's current credentials to determine the target environment:
// `.account` and `.region` will reflect the account+region the CLI
// is configured to use (based on the user CLI credentials)
// Use the CLI's current credentials to determine the target environment:
// `.account` and `.region` will reflect the account+region the CLI
// is configured to use (based on the user CLI credentials)
new Stack(app, "Stack2", new StackProps {
Env = new Environment {
Account = process.Env.CDK_DEFAULT_ACCOUNT,
Region = process.Env.CDK_DEFAULT_REGION
}
});
// Define multiple stacks stage associated with an environment
var myStage = new Stage(app, "MyStage", new StageProps {
Env = new Environment {
Account = "123456789012",
Region = "us-east-1"
}
});
// both of these stacks will use the stage's account/region:
// `.account` and `.region` will resolve to the concrete values as above
// both of these stacks will use the stage's account/region:
// `.account` and `.region` will resolve to the concrete values as above
new MyStack(myStage, "Stack1");
new YourStack(myStage, "Stack2");
// Define an environment-agnostic stack:
// `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
// which will only resolve to actual values by CloudFormation during deployment.
// Define an environment-agnostic stack:
// `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
// which will only resolve to actual values by CloudFormation during deployment.
new MyStack(app, "Stack1");Remarks
Set the region/account fields of env to either a concrete value to
select the indicated environment (recommended for production stacks), or to
the values of environment variables
CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment
depend on the AWS credentials/configuration that the CDK CLI is executed
under (recommended for development stacks).
If the Stack is instantiated inside a Stage, any undefined
region/account fields from env will default to the same field on the
encompassing Stage, if configured there.
If either region or account are not set nor inherited from Stage, the
Stack will be considered "environment-agnostic"". Environment-agnostic
stacks can be deployed to any environment but may not be able to take
advantage of all features of the CDK. For example, they will not be able to
use environmental context lookups such as ec2.Vpc.fromLookup and will not
automatically translate Service Principals to the right format based on the
environment's AWS partition, and other such enhancements.
Default: - The environment of the containing Stage if available,
otherwise create the stack will be environment-agnostic.
StackName
Name to deploy the stack with.
public string? StackName { get; set; }Property Value
Remarks
Default: - Derived from construct path.
Synthesizer
Synthesis method to use while deploying this stack.
public IStackSynthesizer? Synthesizer { get; set; }Property Value
Remarks
Default: - DefaultStackSynthesizer if the @aws-cdk/core:newStyleStackSynthesis feature flag
is set, LegacyStackSynthesizer otherwise.
Tags
Stack tags that will be applied to all the taggable resources and the stack itself.
public IDictionary<string, string>? Tags { get; set; }Property Value
Remarks
Default: {}
TerminationProtection
Whether to enable termination protection for this stack.
public bool? TerminationProtection { get; set; }Property Value
- bool?
Remarks
Default: false