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 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
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 statck 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. |
AttributeGroup(id, attributeGroupProps)
addpublic 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.
RemovalPolicy(policy)
applypublic applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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
).
AllStacksInScope(construct)
associatepublic 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.
ApplicationWithStack(stack)
associatepublic associateApplicationWithStack(stack: Stack): void
Parameters
- stack
Stack
— a CFN stack.
Associate a Cloudformation statck with the application in the given stack.
AttributeGroup(attributeGroup)
associatepublic associateAttributeGroup(attributeGroup: IAttributeGroup): void
Parameters
- attributeGroup
IAttribute
— AppRegistry attribute group.Group
Associate this application with an attribute group.
Stack(stack)
associatepublic associateStack(stack: Stack): void
⚠️ Deprecated: Use associateApplicationWithStack
instead.
Parameters
- stack
Stack
— a CFN stack.
Associate this application with a CloudFormation stack.
Application(id, shareOptions)
sharepublic 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.