class Application (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Servicecatalogappregistry.Alpha.Application
Go	github.com/aws/aws-cdk-go/awscdkservicecatalogappregistryalpha/v2#Application
Java	software.amazon.awscdk.services.servicecatalogappregistry.alpha.Application
Python	aws_cdk.aws_servicecatalogappregistry_alpha.Application
TypeScript (source)	@aws-cdk/aws-servicecatalogappregistry-alpha » Application

Implements IConstruct, IDependable, IResource, IApplication

A Service Catalog AppRegistry Application.

Example

const application = new appreg.Application(this, 'MyFirstApplication', {
  applicationName: 'MyFirstApplicationName',
  description: 'description for my application', // the description is optional
});

Initializer

new Application(scope: Construct, id: string, props: ApplicationProps)

Parameters

• scope Construct
• id string
• props ApplicationProps

Construct Props

Name	Type	Description
applicationName🔹	string	Enforces a particular physical application name.
description?🔹	string	Description for application.

---

applicationName🔹

Type: string

Enforces a particular physical application name.

---

description?🔹

Type: string (optional, default: No description provided)

Description for application.

Properties

Name	Type	Description
applicationArn🔹	string	The ARN of the application.
applicationId🔹	string	The ID of the application.
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.
applicationManagerUrl?🔹	string	Application manager URL for the Application.
applicationName?🔹	string	The 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.

---

applicationManagerUrl?🔹

Type: string (optional)

Application manager URL for the Application.

---

applicationName?🔹

Type: string (optional)

The name of the application.

Methods

Name	Description
addAttributeGroup(id, props)🔹	Create an attribute group and associate this application with the created attribute group.
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
associateAllStacksInScope(scope)🔹	Associate all stacks present in construct's aspect with application, including cross-account stacks.
associateApplicationWithStack(stack)🔹	Associate stack with the application in the stack passed as parameter.
associateAttributeGroup(attributeGroup)⚠️	Associate an attribute group with application If the attribute group is already associated, it will ignore duplicate request.
associateStack(stack)⚠️	Associate a stack with the application If the resource is already associated, it will ignore duplicate request.
shareApplication(id, shareOptions)🔹	Share an application with accounts, organizations and OUs, and IAM roles and users.
toString()🔹	Returns a string representation of this construct.
protected generateUniqueHash(resourceAddress)🔹	Create a unique id.
static fromApplicationArn(scope, id, applicationArn)🔹	Imports an Application construct that represents an external application.

---

addAttributeGroup(id, props)🔹

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

Parameters

• id string
• props AttributeGroupAssociationProps

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(scope)🔹

public associateAllStacksInScope(scope: Construct): void

Parameters

• scope Construct

Associate all stacks present in construct's aspect with application, including cross-account stacks.

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

Associate stack with the application in the stack passed as parameter.

A stack can only be associated with one application.

---

associateAttributeGroup(attributeGroup)⚠️

public associateAttributeGroup(attributeGroup: IAttributeGroup): void

⚠️ Deprecated: Use AttributeGroup.associateWith instead.

Parameters

• attributeGroup IAttributeGroup

Associate an attribute group with application If the attribute group is already associated, it will ignore duplicate request.

---

associateStack(stack)⚠️

public associateStack(stack: Stack): void

⚠️ Deprecated: Use associateApplicationWithStack instead.

Parameters

• stack Stack

Associate a stack with the application If the resource is already associated, it will ignore duplicate request.

A stack can only be associated with one application.

---

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 an application with accounts, organizations and OUs, and IAM roles and users.

The application will become available to end users within those principals.

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected generateUniqueHash(resourceAddress)🔹

protected generateUniqueHash(resourceAddress: string): string

Parameters

• resourceAddress string

Returns

• string

Create a unique id.

---

static fromApplicationArn(scope, id, applicationArn)🔹

public static fromApplicationArn(scope: Construct, id: string, applicationArn: string): IApplication

Parameters

• scope Construct — The parent creating construct (usually this).
• id string — The construct's name.
• applicationArn string — the Amazon Resource Name of the existing AppRegistry Application.

Returns

• IApplication

Imports an Application construct that represents an external application.