TargetApplication

class aws_cdk.aws_servicecatalogappregistry_alpha.TargetApplication

Bases: object

(experimental) Contains static factory methods with which you can build the input needed for application associator to work.

Stability:: experimental
ExampleMetadata:: infused

Example:

import aws_cdk as cdk


app = App()

associated_app = appreg.ApplicationAssociator(app, "AssociatedApplication",
    applications=[appreg.TargetApplication.create_application_stack(
        application_name="MyAssociatedApplication",
        # 'Application containing stacks deployed via CDK.' is the default
        application_description="Associated Application description",
        stack_name="MyAssociatedApplicationStack",
        # AWS Account and Region that are implied by the current CLI configuration is the default
        env=cdk.Environment(account="123456789012", region="us-east-1")
    )]
)

# Associate application to the attribute group.
associated_app.app_registry_application.add_attribute_group("MyAttributeGroup",
    attribute_group_name="MyAttributeGroupName",
    description="Test attribute group",
    attributes={}
)

Stability:: experimental

Methods

abstractmethod bind(scope)

(experimental) Called when the ApplicationAssociator is initialized.

Parameters:: scope (Construct)
Stability:: experimental
Return type:: BindTargetApplicationResult

Static Methods

classmethod create_application_stack(*, application_name, application_description=None, emit_application_manager_url_as_output=None, associate_cross_account_stacks=None, stack_id=None, analytics_reporting=None, cross_region_references=None, description=None, env=None, notification_arns=None, permissions_boundary=None, property_injectors=None, stack_name=None, suppress_template_indentation=None, synthesizer=None, tags=None, termination_protection=None)

(experimental) Factory method to build the input using the provided application name and stack props.

Parameters:

application_name (str) – (experimental) Enforces a particular physical application name.
application_description (Optional[str]) – (experimental) Application description. Default: - Application containing stacks deployed via CDK.
emit_application_manager_url_as_output (Optional[bool]) – (experimental) Whether create cloudFormation Output for application manager URL. Default: - true
associate_cross_account_stacks (Optional[bool]) – (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
stack_id (Optional[str]) – (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
analytics_reporting (Optional[bool]) – Include runtime versioning information in this Stack. Default: analyticsReporting setting of containing App, or value of ‘aws:cdk:version-reporting’ context key
cross_region_references (Optional[bool]) – 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
description (Optional[str]) – A description of the stack. Default: - No description.
env (Union[Environment, Dict[str, Any], None]) – 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. Default: - The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.
notification_arns (Optional[Sequence[str]]) – SNS Topic ARNs that will receive stack events. Default: - no notification arns.
permissions_boundary (Optional[PermissionsBoundary]) – Options for applying a permissions boundary to all IAM Roles and Users created within this Stage. Default: - no permissions boundary is applied
property_injectors (Optional[Sequence[IPropertyInjector]]) – A list of IPropertyInjector attached to this Stack. Default: - no PropertyInjectors
stack_name (Optional[str]) – Name to deploy the stack with. Default: - Derived from construct path.
suppress_template_indentation (Optional[bool]) – 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. Default: - the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
synthesizer (Optional[IStackSynthesizer]) – 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. Default: - The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
tags (Optional[Mapping[str, str]]) – Tags 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 excludeResourceTypes property of Tags.of(...).add()) for tags applied in this way. Default: {}
termination_protection (Optional[bool]) – Whether to enable termination protection for this stack. Default: false

Stability:

experimental

Return type:

TargetApplication

classmethod existing_application_from_arn(*, application_arn_value, associate_cross_account_stacks=None, stack_id=None, analytics_reporting=None, cross_region_references=None, description=None, env=None, notification_arns=None, permissions_boundary=None, property_injectors=None, stack_name=None, suppress_template_indentation=None, synthesizer=None, tags=None, termination_protection=None)

(experimental) Factory method to build the input using the provided application ARN.

Parameters:

application_arn_value (str) – (experimental) Enforces a particular application arn.
associate_cross_account_stacks (Optional[bool]) – (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
stack_id (Optional[str]) –
(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
analytics_reporting (Optional[bool]) – Include runtime versioning information in this Stack. Default: analyticsReporting setting of containing App, or value of ‘aws:cdk:version-reporting’ context key
cross_region_references (Optional[bool]) – 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
description (Optional[str]) – A description of the stack. Default: - No description.
env (Union[Environment, Dict[str, Any], None]) – 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. Default: - The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.
notification_arns (Optional[Sequence[str]]) – SNS Topic ARNs that will receive stack events. Default: - no notification arns.
permissions_boundary (Optional[PermissionsBoundary]) – Options for applying a permissions boundary to all IAM Roles and Users created within this Stage. Default: - no permissions boundary is applied
property_injectors (Optional[Sequence[IPropertyInjector]]) – A list of IPropertyInjector attached to this Stack. Default: - no PropertyInjectors
stack_name (Optional[str]) – Name to deploy the stack with. Default: - Derived from construct path.
suppress_template_indentation (Optional[bool]) – 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. Default: - the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
synthesizer (Optional[IStackSynthesizer]) – 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. Default: - The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
tags (Optional[Mapping[str, str]]) – Tags 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 excludeResourceTypes property of Tags.of(...).add()) for tags applied in this way. Default: {}
termination_protection (Optional[bool]) – Whether to enable termination protection for this stack. Default: false

Stability:

experimental

Return type:

TargetApplication