interface IApplication
| Language | Type name |
|---|---|
.NET | Amazon.CDK.AWS.Servicecatalogappregistry.Alpha.IApplication |
Go | github.com/aws/aws-cdk-go/awscdkservicecatalogappregistryalpha/v2#IApplication |
Java | software.amazon.awscdk.services.servicecatalogappregistry.alpha.IApplication |
Python | aws_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
| Name | Type | Description |
|---|---|---|
| application | string | The ARN of the application. |
| application | string | The ID of the application. |
| env | Resource | The environment this resource belongs to. |
| node | Node | The tree node. |
| stack | Stack | The stack in which this resource is defined. |
| application | string | The name of the application. |
applicationArn
Type:
string
The ARN of the application.
applicationId
Type:
string
The ID of the application.
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed in a Stack (those created by
creating new class instances like new Role(), new Bucket(), etc.), this
is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like
Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they 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
| Name | Description |
|---|---|
| add | Create an attribute group and associate this application with the created attribute group. |
| apply | Apply the given removal policy to this resource. |
| associate | Associate this application with all stacks under the construct node. |
| associate | Associate a Cloudformation stack with the application in the given stack. |
| associate | Associate this application with an attribute group. |
| associate | Associate this application with a CloudFormation stack. |
| share | 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
Attributeโ AppRegistry attribute group props.Group Association Props
Returns
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 stack with the application in the given stack.
associateAttributeGroup(attributeGroup)
public associateAttributeGroup(attributeGroup: IAttributeGroup): void
Parameters
- attributeGroup
IAttributeโ AppRegistry attribute group.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
Shareโ The options for the share.Options
Share this application with other IAM entities, accounts, or OUs.

.NET
Go
Java
Python
TypeScript (