@aws-cdk_aws-servicecatalogappregistry-alpha.IApplication

interface IApplication ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Servicecatalogappregistry.Alpha.IApplication
Gogithub.com/aws/aws-cdk-go/awscdkservicecatalogappregistryalpha/v2#IApplication
Javasoftware.amazon.awscdk.services.servicecatalogappregistry.alpha.IApplication
Pythonaws_cdk.aws_servicecatalogappregistry_alpha.IApplication
TypeScript (source)@aws-cdk/aws-servicecatalogappregistry-alpha ยป IApplication

Implemented by Application

Obtainable from Application.fromApplicationArn()

A Service Catalog AppRegistry Application.

Properties

NameTypeDescription
applicationArn๐Ÿ”นstringThe ARN of the application.
applicationId๐Ÿ”นstringThe ID of the application.
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
node๐Ÿ”นNodeThe tree node.
stack๐Ÿ”นStackThe stack in which this resource is defined.
applicationName?๐Ÿ”นstringThe name of the application.

applicationArn๐Ÿ”น

Type: string

The ARN of the application.


applicationId๐Ÿ”น

Type: string

The ID of the application.


env๐Ÿ”น

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


node๐Ÿ”น

Type: Node

The tree node.


stack๐Ÿ”น

Type: Stack

The stack in which this resource is defined.


applicationName?๐Ÿ”น

Type: string (optional)

The name of the application.

Methods

NameDescription
addAttributeGroup(id, attributeGroupProps)๐Ÿ”นCreate an attribute group and associate this application with the created attribute group.
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.
associateAllStacksInScope(construct)๐Ÿ”นAssociate this application with all stacks under the construct node.
associateApplicationWithStack(stack)๐Ÿ”นAssociate a Cloudformation statck with the application in the given stack.
associateAttributeGroup(attributeGroup)๐Ÿ”นAssociate this application with an attribute group.
associateStack(stack)โš ๏ธAssociate this application with a CloudFormation stack.
shareApplication(id, shareOptions)๐Ÿ”นShare this application with other IAM entities, accounts, or OUs.

addAttributeGroup(id, attributeGroupProps)๐Ÿ”น

public addAttributeGroup(id: string, attributeGroupProps: AttributeGroupAssociationProps): IAttributeGroup

Parameters

  • id string โ€” name of the AttributeGroup construct to be created.
  • attributeGroupProps AttributeGroupAssociationProps โ€” AppRegistry attribute group props.

Returns

  • IAttributeGroup

Create an attribute group and associate this application with the created attribute group.


applyRemovalPolicy(policy)๐Ÿ”น

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).


associateAllStacksInScope(construct)๐Ÿ”น

public associateAllStacksInScope(construct: Construct): void

Parameters

  • construct Construct โ€” cdk Construct.

Associate this application with all stacks under the construct node.

NOTE: This method won't automatically register stacks under pipeline stages, and requires association of each pipeline stage by calling this method with stage Construct.


associateApplicationWithStack(stack)๐Ÿ”น

public associateApplicationWithStack(stack: Stack): void

Parameters

  • stack Stack โ€” a CFN stack.

Associate a Cloudformation statck with the application in the given stack.


associateAttributeGroup(attributeGroup)๐Ÿ”น

public associateAttributeGroup(attributeGroup: IAttributeGroup): void

Parameters

  • attributeGroup IAttributeGroup โ€” AppRegistry attribute group.

Associate this application with an attribute group.


associateStack(stack)โš ๏ธ

public associateStack(stack: Stack): void

โš ๏ธ Deprecated: Use associateApplicationWithStack instead.

Parameters

  • stack Stack โ€” a CFN stack.

Associate this application with a CloudFormation stack.


shareApplication(id, shareOptions)๐Ÿ”น

public shareApplication(id: string, shareOptions: ShareOptions): void

Parameters

  • id string โ€” The construct name for the share.
  • shareOptions ShareOptions โ€” The options for the share.

Share this application with other IAM entities, accounts, or OUs.