Experimental
@aws-cdk/aws-servicecatalogappregistry-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
TargetApplicationCommonOptions Struct
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 propertyInjector: cdk.IPropertyInjector;
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,
propertyInjectors: [propertyInjector],
stackId: 'stackId',
stackName: 'stackName',
suppressTemplateIndentation: false,
synthesizer: stackSynthesizer,
tags: {
tagsKey: 'tags',
},
terminationProtection: false,
};
Properties
analyticsReportingoptionalbooleananalytics_reportingoptionalboolanalyticsReportingoptionalBooleanAnalyticsReportingoptionalboolAnalyticsReportingoptional*bool#Default: analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key
associateCrossAccountStacksoptionalbooleanassociate_cross_account_stacksoptionalboolassociateCrossAccountStacksoptionalBooleanAssociateCrossAccountStacksoptionalboolAssociateCrossAccountStacksoptional*bool= false#If set to true, the application will first be shared with the accounts that own the stacks.
crossRegionReferencesoptionalbooleancross_region_referencesoptionalboolcrossRegionReferencesoptionalBooleanCrossRegionReferencesoptionalboolCrossRegionReferencesoptional*bool= false#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
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#Default: No description.
envoptionalEnvironmentenvoptionalEnvironmentenvoptionalEnvironmentEnvoptionalEnvironmentEnvoptionalEnvironment#Default: The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.
notes · example
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.
// 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');
notificationArnsoptionalstring[]notification_arnsoptionaltyping.List[str]notificationArnsoptionalList<String>NotificationArnsoptionalstring[]NotificationArnsoptional*[]*string#Default: no notification arns.
permissionsBoundaryoptionalPermissionsBoundarypermissions_boundaryoptionalPermissionsBoundarypermissionsBoundaryoptionalPermissionsBoundaryPermissionsBoundaryoptionalPermissionsBoundaryPermissionsBoundaryoptionalPermissionsBoundary#Default: no permissions boundary is applied
propertyInjectorsoptionalIPropertyInjector[]property_injectorsoptionaltyping.List[IPropertyInjector]propertyInjectorsoptionalList<IPropertyInjector>PropertyInjectorsoptionalIPropertyInjector[]PropertyInjectorsoptional*[]IPropertyInjector#Default: no PropertyInjectors
stackIdoptionalstringstack_idoptionalstrstackIdoptionalStringStackIdoptionalstringStackIdoptional*stringdeprecated#Default: The value of stackName will be used as stack id
The id of a stack is also the identifier that you use to refer to it in the AWS CDK Toolkit.
stackNameoptionalstringstack_nameoptionalstrstackNameoptionalStringStackNameoptionalstringStackNameoptional*string#Default: Derived from construct path.
suppressTemplateIndentationoptionalbooleansuppress_template_indentationoptionalboolsuppressTemplateIndentationoptionalBooleanSuppressTemplateIndentationoptionalboolSuppressTemplateIndentationoptional*bool#Default: the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
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.
synthesizeroptionalIStackSynthesizersynthesizeroptionalIStackSynthesizersynthesizeroptionalIStackSynthesizerSynthesizeroptionalIStackSynthesizerSynthesizeroptionalIStackSynthesizer#Default: The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
notes
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.
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string= {}#notes
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 excludeResourceTypes property of Tags.of(...).add()) for tags applied in this way.
terminationProtectionoptionalbooleantermination_protectionoptionalboolterminationProtectionoptionalBooleanTerminationProtectionoptionalboolTerminationProtectionoptional*bool= false#