interface TargetApplicationCommonOptions
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Servicecatalogappregistry.Alpha.TargetApplicationCommonOptions |
 Go | github.com/aws/aws-cdk-go/awscdkservicecatalogappregistryalpha/v2#TargetApplicationCommonOptions |
 Java | software.amazon.awscdk.services.servicecatalogappregistry.alpha.TargetApplicationCommonOptions |
 Python | aws_cdk.aws_servicecatalogappregistry_alpha.TargetApplicationCommonOptions |
 TypeScript (source) | @aws-cdk/aws-servicecatalogappregistry-alpha » TargetApplicationCommonOptions |
Properties used to define targetapplication.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as servicecatalogappregistry_alpha from '@aws-cdk/aws-servicecatalogappregistry-alpha';
import * as cdk from 'aws-cdk-lib';
declare const permissionsBoundary: cdk.PermissionsBoundary;
declare const stackSynthesizer: cdk.StackSynthesizer;
const targetApplicationCommonOptions: servicecatalogappregistry_alpha.TargetApplicationCommonOptions = {
analyticsReporting: false,
associateCrossAccountStacks: false,
crossRegionReferences: false,
description: 'description',
env: {
account: 'account',
region: 'region',
},
notificationArns: ['notificationArns'],
permissionsBoundary: permissionsBoundary,
stackId: 'stackId',
stackName: 'stackName',
suppressTemplateIndentation: false,
synthesizer: stackSynthesizer,
tags: {
tagsKey: 'tags',
},
terminationProtection: false,
};
Properties
| Name | Type | Description |
|---|---|---|
| analytics | boolean | Include runtime versioning information in this Stack. |
| associate | boolean | Determines whether any cross-account stacks defined in the CDK app definition should be associated with the target application. |
| cross | boolean | Enable this flag to allow native cross region stack references. |
| description? | string | A description of the stack. |
| env? | Environment | The AWS environment (account/region) where this stack will be deployed. |
| notification | string[] | SNS Topic ARNs that will receive stack events. |
| permissions | Permissions | Options for applying a permissions boundary to all IAM Roles and Users created within this Stage. |
| stack | string | Stack ID in which application will be created or imported. |
| stack | string | Name to deploy the stack with. |
| suppress | boolean | Enable this flag to suppress indentation in generated CloudFormation templates. |
| synthesizer? | IStack | Synthesis method to use while deploying this stack. |
| tags? | { [string]: string } | Stack tags that will be applied to all the taggable resources and the stack itself. |
| termination | boolean | Whether to enable termination protection for this stack. |
analyticsReporting?
Type:
boolean
(optional, default: analyticsReporting setting of containing App, or value of
'aws:cdk:version-reporting' context key)
Include runtime versioning information in this Stack.
associateCrossAccountStacks?
Type:
boolean
(optional, default: false)
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.
crossRegionReferences?
Type:
boolean
(optional, default: false)
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
description?
Type:
string
(optional, default: No description.)
A description of the stack.
env?
Type:
Environment
(optional, default: The environment of the containing Stage if available,
otherwise create the stack will be environment-agnostic.)
The AWS environment (account/region) where this stack will be deployed.
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.
Example
// Use a concrete account and region to deploy this stack to:
// `.account` and `.region` will simply return these values.
new Stack(app, 'Stack1', {
env: {
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)
new Stack(app, 'Stack2', {
env: {
account: process.env.CDK_DEFAULT_ACCOUNT,
region: process.env.CDK_DEFAULT_REGION
},
});
// Define multiple stacks stage associated with an environment
const myStage = new Stage(app, 'MyStage', {
env: {
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
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.
new MyStack(app, 'Stack1');
notificationArns?
Type:
string[]
(optional, default: no notfication arns.)
SNS Topic ARNs that will receive stack events.
permissionsBoundary?
Type:
Permissions
(optional, default: no permissions boundary is applied)
Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.
stackId?
⚠️ Deprecated: - Use stackName instead to control the name and id of the stack
Type:
string
(optional, default: The value of stackName will be used as stack id)
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.
stackName?
Type:
string
(optional, default: Derived from construct path.)
Name to deploy the stack with.
suppressTemplateIndentation?
Type:
boolean
(optional, default: the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.)
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 value false will be used.
synthesizer?
Type:
IStack
(optional, default: The synthesizer specified on App, or DefaultStackSynthesizer otherwise.)
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 from App will be used.
If that is not specified, DefaultStackSynthesizer is used if
@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major
version is v2. In CDK v1 LegacyStackSynthesizer is the default if no
other synthesizer is specified.
tags?
Type:
{ [string]: string }
(optional, default: {})
Stack tags that will be applied to all the taggable resources and the stack itself.
terminationProtection?
Type:
boolean
(optional, default: false)
Whether to enable termination protection for this stack.