@Stability(value=Experimental) @Internal public static final class StackProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements StackProps
StackPropssoftware.amazon.jsii.JsiiObject.InitializationModeStackProps.Builder, StackProps.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
protected |
Jsii$Proxy(Boolean analyticsReporting,
String description,
Environment env,
String stackName,
IStackSynthesizer synthesizer,
Map<String,String> tags,
Boolean terminationProtection)
Constructor that initializes the object based on literal property values passed by the
StackProps.Builder. |
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
| Modifier and Type | Method and Description |
|---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(Object o) |
Boolean |
getAnalyticsReporting()
(experimental) Include runtime versioning information in this Stack.
|
String |
getDescription()
(experimental) A description of the stack.
|
Environment |
getEnv()
(experimental) The AWS environment (account/region) where this stack will be deployed.
|
String |
getStackName()
(experimental) Name to deploy the stack with.
|
IStackSynthesizer |
getSynthesizer()
(experimental) Synthesis method to use while deploying this stack.
|
Map<String,String> |
getTags()
(experimental) Stack tags that will be applied to all the taggable resources and the stack itself.
|
Boolean |
getTerminationProtection()
(experimental) Whether to enable termination protection for this stack.
|
int |
hashCode() |
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbuilderprotected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef - Reference to the JSII managed object.protected Jsii$Proxy(Boolean analyticsReporting, String description, Environment env, String stackName, IStackSynthesizer synthesizer, Map<String,String> tags, Boolean terminationProtection)
StackProps.Builder.public final Boolean getAnalyticsReporting()
StackPropsDefault: `analyticsReporting` setting of containing `App`, or value of 'aws:cdk:version-reporting' context key
getAnalyticsReporting in interface StackPropspublic final String getDescription()
StackPropsDefault: - No description.
getDescription in interface StackPropspublic final Environment getEnv()
StackProps
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.
Example:
// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 // 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.getCDK_DEFAULT_ACCOUNT()) .region(process.env.getCDK_DEFAULT_REGION()))); // Define multiple stacks stage associated with an environment Stage 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");
getEnv in interface StackPropspublic final String getStackName()
StackPropsDefault: - Derived from construct path.
getStackName in interface StackPropspublic final IStackSynthesizer getSynthesizer()
StackPropsDefault: - `DefaultStackSynthesizer` if the `@aws-cdk/core:newStyleStackSynthesis` feature flag is set, `LegacyStackSynthesizer` otherwise.
getSynthesizer in interface StackPropspublic final Map<String,String> getTags()
StackPropsDefault: {}
getTags in interface StackPropspublic final Boolean getTerminationProtection()
StackPropsDefault: false
getTerminationProtection in interface StackProps@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson in interface software.amazon.jsii.JsiiSerializableCopyright © 2021. All rights reserved.