Class ExistingTargetApplicationOptions.Jsii$Proxy
- All Implemented Interfaces:
ExistingTargetApplicationOptions,TargetApplicationCommonOptions,StackProps,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
ExistingTargetApplicationOptions
ExistingTargetApplicationOptions-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.servicecatalogappregistry.alpha.ExistingTargetApplicationOptions
ExistingTargetApplicationOptions.Builder, ExistingTargetApplicationOptions.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor that initializes the object based on literal property values passed by theExistingTargetApplicationOptions.Builder.protectedJsii$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.JsonNodefinal booleanfinal BooleanInclude runtime versioning information in this Stack.final String(experimental) Enforces a particular application arn.final Boolean(experimental) Determines whether any cross-account stacks defined in the CDK app definition should be associated with the target application.final BooleanEnable this flag to allow native cross region stack references.final StringA description of the stack.final EnvironmentgetEnv()The AWS environment (account/region) where this stack will be deployed.SNS Topic ARNs that will receive stack events.final PermissionsBoundaryOptions for applying a permissions boundary to all IAM Roles and Users created within this Stage.final List<IPropertyInjector> A list of IPropertyInjector attached to this Stack.final String(deprecated) Stack ID in which application will be created or imported.final StringName to deploy the stack with.final BooleanEnable this flag to suppress indentation in generated CloudFormation templates.final IStackSynthesizerSynthesis method to use while deploying this stack.getTags()Tags that will be applied to the Stack.final BooleanWhether to enable termination protection for this stack.final inthashCode()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 theExistingTargetApplicationOptions.Builder.
-
-
Method Details
-
getApplicationArnValue
Description copied from interface:ExistingTargetApplicationOptions(experimental) Enforces a particular application arn.- Specified by:
getApplicationArnValuein interfaceExistingTargetApplicationOptions
-
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:
getAssociateCrossAccountStacksin 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:
getStackIdin interfaceTargetApplicationCommonOptions
-
getAnalyticsReporting
Description copied from interface:StackPropsInclude runtime versioning information in this Stack.Default: `analyticsReporting` setting of containing `App`, or value of 'aws:cdk:version-reporting' context key
- Specified by:
getAnalyticsReportingin interfaceStackProps
-
getCrossRegionReferences
Description copied from interface:StackPropsEnable 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:
getCrossRegionReferencesin interfaceStackProps
-
getDescription
Description copied from interface:StackPropsA description of the stack.Default: - No description.
- Specified by:
getDescriptionin interfaceStackProps
-
getEnv
Description copied from interface:StackPropsThe AWS environment (account/region) where this stack will be deployed.Set the
region/accountfields ofenvto either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variablesCDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNTto let the target environment depend on the AWS credentials/configuration that the CDK CLI is executed under (recommended for development stacks).If the
Stackis instantiated inside aStage, any undefinedregion/accountfields fromenvwill default to the same field on the encompassingStage, if configured there.If either
regionoraccountare 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.fromLookupand 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:
getEnvin interfaceStackProps
-
getNotificationArns
Description copied from interface:StackPropsSNS Topic ARNs that will receive stack events.Default: - no notification arns.
- Specified by:
getNotificationArnsin interfaceStackProps
-
getPermissionsBoundary
Description copied from interface:StackPropsOptions for applying a permissions boundary to all IAM Roles and Users created within this Stage.Default: - no permissions boundary is applied
- Specified by:
getPermissionsBoundaryin interfaceStackProps
-
getPropertyInjectors
Description copied from interface:StackPropsA list of IPropertyInjector attached to this Stack.Default: - no PropertyInjectors
- Specified by:
getPropertyInjectorsin interfaceStackProps
-
getStackName
Description copied from interface:StackPropsName to deploy the stack with.Default: - Derived from construct path.
- Specified by:
getStackNamein interfaceStackProps
-
getSuppressTemplateIndentation
Description copied from interface:StackPropsEnable this flag to suppress indentation in generated CloudFormation templates.If not specified, the value of the
@aws-cdk/core:suppressTemplateIndentationcontext key will be used. If that is not specified, then the default valuefalsewill be used.Default: - the value of `@aws-cdk/core:suppressTemplateIndentation`, or `false` if that is not set.
- Specified by:
getSuppressTemplateIndentationin interfaceStackProps
-
getSynthesizer
Description copied from interface:StackPropsSynthesis 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
defaultStackSynthesizerfromAppwill be used. If that is not specified,DefaultStackSynthesizeris used if@aws-cdk/core:newStyleStackSynthesisis set totrueor the CDK major version is v2. In CDK v1LegacyStackSynthesizeris the default if no other synthesizer is specified.Default: - The synthesizer specified on `App`, or `DefaultStackSynthesizer` otherwise.
- Specified by:
getSynthesizerin interfaceStackProps
-
getTags
Description copied from interface:StackPropsTags that will be applied to the Stack.These tags are applied to the CloudFormation Stack itself. They will not appear in the CloudFormation template.
However, at deployment time, CloudFormation will apply these tags to all resources in the stack that support tagging. You will not be able to exempt resources from tagging (using the
excludeResourceTypesproperty ofTags.of(...).add()) for tags applied in this way.Default: {}
- Specified by:
getTagsin interfaceStackProps
-
getTerminationProtection
Description copied from interface:StackPropsWhether to enable termination protection for this stack.Default: false
- Specified by:
getTerminationProtectionin interfaceStackProps
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-