AWS ServiceCatalogAppRegistry Construct Library
AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2.
For more information on how to migrate, see the Migrating to AWS CDK v2 guide.
AWS Service Catalog App Registry enables organizations to create and manage repositores of applications and associated resources.
Table Of Contents
@aws-cdk/aws-servicecatalogappregistry package contains resources that enable users to automate governance and management of their AWS resources at scale.
An AppRegistry application enables you to define your applications and associated resources. The application name must be unique at the account level, but is mutable.
Application application = Application.Builder.create(this, "MyFirstApplication") .applicationName("MyFirstApplicationName") .description("description for my application") .build();
An application that has been created outside of the stack can be imported into your CDK app.
Applications can be imported by their ARN via the
IApplication importedApplication = Application.fromApplicationArn(this, "MyImportedApplication", "arn:aws:servicecatalog:us-east-1:012345678910:/applications/0aqmvxvgmry0ecc4mjhwypun6i");
An AppRegistry attribute group acts as a container for user-defined attributes for an application. Metadata is attached in a machine-readble format to integrate with automated workflows and tools.
AttributeGroup attributeGroup = AttributeGroup.Builder.create(this, "MyFirstAttributeGroup") .attributeGroupName("MyFirstAttributeGroupName") .description("description for my attribute group") // the description is optional, .attributes(Map.of( "project", "foo", "team", List.of("member1", "member2", "member3"), "public", false, "stages", Map.of( "alpha", "complete", "beta", "incomplete", "release", "not started"))) .build();
An attribute group that has been created outside of the stack can be imported into your CDK app.
Attribute groups can be imported by their ARN via the
IAttributeGroup importedAttributeGroup = AttributeGroup.fromAttributeGroupArn(this, "MyImportedAttrGroup", "arn:aws:servicecatalog:us-east-1:012345678910:/attribute-groups/0aqmvxvgmry0ecc4mjhwypun6i");
You can associate your appregistry application with attribute groups and resources. Resources are CloudFormation stacks that you can associate with an application to group relevant stacks together to enable metadata rich insights into your applications and resources. A Cloudformation stack can only be associated with one appregistry application. If a stack is associated with multiple applications in your app or is already associated with one, CDK will fail at deploy time.
Associating application with an attribute group
You can associate an attribute group with an application with the
Application application; AttributeGroup attributeGroup; application.associateAttributeGroup(attributeGroup);
Associating application with a Stack
You can associate a stack with an application with the
Deprecated: AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2. For more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.htmlApplication application; App app = new App(); Stack myStack = new Stack(app, "MyStack"); application.associateStack(myStack);
ClassDescription(experimental) A Service Catalog AppRegistry Application.(experimental) A fluent builder for
Application.(experimental) Properties for a Service Catalog AppRegistry Application.A builder for
ApplicationPropsAn implementation for
ApplicationProps(experimental) A Service Catalog AppRegistry Attribute Group.(experimental) A fluent builder for
AttributeGroup.(experimental) Properties for a Service Catalog AppRegistry Attribute Group.A builder for
AttributeGroupPropsAn implementation for
AWS::ServiceCatalogAppRegistry::Application.A fluent builder for
CfnApplication.Properties for defining a
CfnApplication.A builder for
CfnApplicationPropsAn implementation for
AWS::ServiceCatalogAppRegistry::AttributeGroup.A fluent builder for
AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation.A fluent builder for
CfnAttributeGroupAssociation.Properties for defining a
CfnAttributeGroupAssociation.A builder for
CfnAttributeGroupAssociationPropsAn implementation for
CfnAttributeGroupAssociationPropsProperties for defining a
CfnAttributeGroup.A builder for
CfnAttributeGroupPropsAn implementation for
AWS::ServiceCatalogAppRegistry::ResourceAssociation.A fluent builder for
CfnResourceAssociation.Properties for defining a
CfnResourceAssociation.A builder for
CfnResourceAssociationPropsAn implementation for
CfnResourceAssociationProps(experimental) A Service Catalog AppRegistry Application.Internal default implementation for