Class ExistingTargetApplicationOptions
(experimental) Properties used to define Existing TargetApplication.
Inheritance
Namespace: Amazon.CDK.AWS.Servicecatalogappregistry.Alpha
Assembly: Amazon.CDK.AWS.ServiceCatalogAppRegistry.Alpha.dll
Syntax (csharp)
public class ExistingTargetApplicationOptions : Object, IExistingTargetApplicationOptions, ITargetApplicationCommonOptions, IStackProps
Syntax (vb)
Public Class ExistingTargetApplicationOptions
Inherits Object
Implements IExistingTargetApplicationOptions, ITargetApplicationCommonOptions, IStackProps
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
var app = new App();
var associatedApp = new ApplicationAssociator(app, "AssociatedApplication", new ApplicationAssociatorProps {
Applications = new [] { TargetApplication.ExistingApplicationFromArn(new ExistingTargetApplicationOptions {
ApplicationArnValue = "arn:aws:servicecatalog:us-east-1:123456789012:/applications/applicationId",
StackName = "MyAssociatedApplicationStack"
}) }
});
Synopsis
Constructors
ExistingTargetApplicationOptions() |
Properties
AnalyticsReporting | Include runtime versioning information in this Stack. |
ApplicationArnValue | (experimental) Enforces a particular application arn. |
AssociateCrossAccountStacks | (experimental) Determines whether any cross-account stacks defined in the CDK app definition should be associated with the target application. |
CrossRegionReferences | Enable this flag to allow native cross region stack references. |
Description | A description of the stack. |
Env | The AWS environment (account/region) where this stack will be deployed. |
PermissionsBoundary | Options for applying a permissions boundary to all IAM Roles and Users created within this Stage. |
StackId | (deprecated) Stack ID in which application will be created or imported. |
StackName | Name to deploy the stack with. |
SuppressTemplateIndentation | Enable this flag to suppress indentation in generated CloudFormation templates. |
Synthesizer | Synthesis method to use while deploying this stack. |
Tags | Stack tags that will be applied to all the taggable resources and the stack itself. |
TerminationProtection | Whether to enable termination protection for this stack. |
Constructors
ExistingTargetApplicationOptions()
public ExistingTargetApplicationOptions()
Properties
AnalyticsReporting
Include runtime versioning information in this Stack.
public Nullable<bool> AnalyticsReporting { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: analyticsReporting
setting of containing App
, or value of
'aws:cdk:version-reporting' context key
ApplicationArnValue
(experimental) Enforces a particular application arn.
public string ApplicationArnValue { get; set; }
Property Value
System.String
Remarks
Stability: Experimental
AssociateCrossAccountStacks
(experimental) Determines whether any cross-account stacks defined in the CDK app definition should be associated with the target application.
public Nullable<bool> AssociateCrossAccountStacks { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
If set to true
, the application will first be shared with the accounts that own the stacks.
Default: - false
Stability: Experimental
CrossRegionReferences
Enable this flag to allow native cross region stack references.
public Nullable<bool> CrossRegionReferences { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
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
Description
A description of the stack.
public string Description { get; set; }
Property Value
System.String
Remarks
Default: - No description.
Env
The AWS environment (account/region) where this stack will be deployed.
public IEnvironment Env { get; set; }
Property Value
Remarks
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.
Examples
// 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.CDK_DEFAULT_ACCOUNT,
Region = process.Env.CDK_DEFAULT_REGION
}
});
// Define multiple stacks stage associated with an environment
var 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");
PermissionsBoundary
Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.
public PermissionsBoundary PermissionsBoundary { get; set; }
Property Value
Remarks
Default: - no permissions boundary is applied
StackId
(deprecated) Stack ID in which application will be created or imported.
public string StackId { get; set; }
Property Value
System.String
Remarks
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
Stability: Deprecated
StackName
Name to deploy the stack with.
public string StackName { get; set; }
Property Value
System.String
Remarks
Default: - Derived from construct path.
SuppressTemplateIndentation
Enable this flag to suppress indentation in generated CloudFormation templates.
public Nullable<bool> SuppressTemplateIndentation { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
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.
Default: - the value of @aws-cdk/core:suppressTemplateIndentation
, or false
if that is not set.
Synthesizer
Synthesis method to use while deploying this stack.
public IStackSynthesizer Synthesizer { get; set; }
Property Value
Remarks
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.
Default: - The synthesizer specified on App
, or DefaultStackSynthesizer
otherwise.
Tags
Stack tags that will be applied to all the taggable resources and the stack itself.
public IDictionary<string, string> Tags { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Default: {}
TerminationProtection
Whether to enable termination protection for this stack.
public Nullable<bool> TerminationProtection { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false