Class TargetApplicationCommonOptions.Jsii$Proxy
- All Implemented Interfaces:
TargetApplicationCommonOptions
,StackProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
TargetApplicationCommonOptions
TargetApplicationCommonOptions
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.servicecatalogappregistry.alpha.TargetApplicationCommonOptions
TargetApplicationCommonOptions.Builder, TargetApplicationCommonOptions.Jsii$Proxy
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Constructor that initializes the object based on literal property values passed by theTargetApplicationCommonOptions.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final Boolean
Include runtime versioning information in this Stack.final Boolean
(experimental) Determines whether any cross-account stacks defined in the CDK app definition should be associated with the target application.final Boolean
Enable this flag to allow native cross region stack references.final String
A description of the stack.final Environment
getEnv()
The AWS environment (account/region) where this stack will be deployed.final PermissionsBoundary
Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.final String
(deprecated) Stack ID in which application will be created or imported.final String
Name to deploy the stack with.final Boolean
Enable this flag to suppress indentation in generated CloudFormation templates.final IStackSynthesizer
Synthesis method to use while deploying this stack.getTags()
Stack tags that will be applied to all the taggable resources and the stack itself.final Boolean
Whether to enable termination protection for this stack.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theTargetApplicationCommonOptions.Builder
.
-
-
Method Details
-
getAssociateCrossAccountStacks
Description copied from interface:TargetApplicationCommonOptions
(experimental) Determines whether any cross-account stacks defined in the CDK app definition should be associated with the target application.If set to
true
, the application will first be shared with the accounts that own the stacks.Default: - false
- Specified by:
getAssociateCrossAccountStacks
in interfaceTargetApplicationCommonOptions
-
getStackId
Description copied from interface:TargetApplicationCommonOptions
(deprecated) Stack ID in which application will be created or imported.The id of a stack is also the identifier that you use to refer to it in the AWS CDK Toolkit.
Default: - The value of `stackName` will be used as stack id
- Specified by:
getStackId
in interfaceTargetApplicationCommonOptions
-
getAnalyticsReporting
Description copied from interface:StackProps
Include runtime versioning information in this Stack.Default: `analyticsReporting` setting of containing `App`, or value of 'aws:cdk:version-reporting' context key
- Specified by:
getAnalyticsReporting
in interfaceStackProps
-
getCrossRegionReferences
Description copied from interface:StackProps
Enable this flag to allow native cross region stack references.Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import
This feature is currently experimental
Default: false
- Specified by:
getCrossRegionReferences
in interfaceStackProps
-
getDescription
Description copied from interface:StackProps
A description of the stack.Default: - No description.
- Specified by:
getDescription
in interfaceStackProps
-
getEnv
Description copied from interface:StackProps
The AWS environment (account/region) where this stack will be deployed.Set the
region
/account
fields ofenv
to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variablesCDK_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 aStage
, any undefinedregion
/account
fields fromenv
will default to the same field on the encompassingStage
, if configured there.If either
region
oraccount
are not set nor inherited fromStage
, 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 asec2.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:
// 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. Stack.Builder.create(app, "Stack1") .env(Environment.builder() .account("123456789012") .region("us-east-1") .build()) .build(); // 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) Stack.Builder.create(app, "Stack2") .env(Environment.builder() .account(process.getEnv().getCDK_DEFAULT_ACCOUNT()) .region(process.getEnv().getCDK_DEFAULT_REGION()) .build()) .build(); // Define multiple stacks stage associated with an environment Stage myStage = Stage.Builder.create(app, "MyStage") .env(Environment.builder() .account("123456789012") .region("us-east-1") .build()) .build(); // 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");
- Specified by:
getEnv
in interfaceStackProps
-
getPermissionsBoundary
Description copied from interface:StackProps
Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.Default: - no permissions boundary is applied
- Specified by:
getPermissionsBoundary
in interfaceStackProps
-
getStackName
Description copied from interface:StackProps
Name to deploy the stack with.Default: - Derived from construct path.
- Specified by:
getStackName
in interfaceStackProps
-
getSuppressTemplateIndentation
Description copied from interface:StackProps
Enable this flag to suppress indentation in generated CloudFormation templates.If not specified, the value of the
@aws-cdk/core:suppressTemplateIndentation
context key will be used. If that is not specified, then the default valuefalse
will be used.Default: - the value of `@aws-cdk/core:suppressTemplateIndentation`, or `false` if that is not set.
- Specified by:
getSuppressTemplateIndentation
in interfaceStackProps
-
getSynthesizer
Description copied from interface:StackProps
Synthesis method to use while deploying this stack.The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.
If not specified, the
defaultStackSynthesizer
fromApp
will be used. If that is not specified,DefaultStackSynthesizer
is used if@aws-cdk/core:newStyleStackSynthesis
is set totrue
or the CDK major version is v2. In CDK v1LegacyStackSynthesizer
is the default if no other synthesizer is specified.Default: - The synthesizer specified on `App`, or `DefaultStackSynthesizer` otherwise.
- Specified by:
getSynthesizer
in interfaceStackProps
-
getTags
Description copied from interface:StackProps
Stack tags that will be applied to all the taggable resources and the stack itself.Default: {}
- Specified by:
getTags
in interfaceStackProps
-
getTerminationProtection
Description copied from interface:StackProps
Whether to enable termination protection for this stack.Default: false
- Specified by:
getTerminationProtection
in interfaceStackProps
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-