Package software.amazon.awscdk.services.servicecatalogappregistry

AWS ServiceCatalogAppRegistry Construct Library

See: Description

Interface Summary

Interface	Description
ApplicationProps	(experimental) Properties for a Service Catalog AppRegistry Application.
AttributeGroupProps	(experimental) Properties for a Service Catalog AppRegistry Attribute Group.
CfnApplicationProps	Properties for defining a `CfnApplication`.
CfnAttributeGroupAssociationProps	Properties for defining a `CfnAttributeGroupAssociation`.
CfnAttributeGroupProps	Properties for defining a `CfnAttributeGroup`.
CfnResourceAssociationProps	Properties for defining a `CfnResourceAssociation`.
IApplication	(experimental) A Service Catalog AppRegistry Application.
IApplication.Jsii$Default	Internal default implementation for IApplication.
IAttributeGroup	(experimental) A Service Catalog AppRegistry Attribute Group.
IAttributeGroup.Jsii$Default	Internal default implementation for IAttributeGroup.

Class Summary

Class	Description
Application	(experimental) A Service Catalog AppRegistry Application.
Application.Builder	(experimental) A fluent builder for Application.
ApplicationProps.Builder	A builder for ApplicationProps
ApplicationProps.Jsii$Proxy	An implementation for ApplicationProps
AttributeGroup	(experimental) A Service Catalog AppRegistry Attribute Group.
AttributeGroup.Builder	(experimental) A fluent builder for AttributeGroup.
AttributeGroupProps.Builder	A builder for AttributeGroupProps
AttributeGroupProps.Jsii$Proxy	An implementation for AttributeGroupProps
CfnApplication	A CloudFormation `AWS::ServiceCatalogAppRegistry::Application`.
CfnApplication.Builder	A fluent builder for CfnApplication.
CfnApplicationProps.Builder	A builder for CfnApplicationProps
CfnApplicationProps.Jsii$Proxy	An implementation for CfnApplicationProps
CfnAttributeGroup	A CloudFormation `AWS::ServiceCatalogAppRegistry::AttributeGroup`.
CfnAttributeGroup.Builder	A fluent builder for CfnAttributeGroup.
CfnAttributeGroupAssociation	A CloudFormation `AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation`.
CfnAttributeGroupAssociation.Builder	A fluent builder for CfnAttributeGroupAssociation.
CfnAttributeGroupAssociationProps.Builder	A builder for CfnAttributeGroupAssociationProps
CfnAttributeGroupAssociationProps.Jsii$Proxy	An implementation for CfnAttributeGroupAssociationProps
CfnAttributeGroupProps.Builder	A builder for CfnAttributeGroupProps
CfnAttributeGroupProps.Jsii$Proxy	An implementation for CfnAttributeGroupProps
CfnResourceAssociation	A CloudFormation `AWS::ServiceCatalogAppRegistry::ResourceAssociation`.
CfnResourceAssociation.Builder	A fluent builder for CfnResourceAssociation.
CfnResourceAssociationProps.Builder	A builder for CfnResourceAssociationProps
CfnResourceAssociationProps.Jsii$Proxy	An implementation for CfnResourceAssociationProps
IApplication.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IAttributeGroup.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Package software.amazon.awscdk.services.servicecatalogappregistry Description

AWS ServiceCatalogAppRegistry Construct Library

AWS Service Catalog App Registry enables organizations to create and manage repositores of applications and associated resources.

Table Of Contents

• Application
• Attribute-Group
• Associations
  • Associating application with an attribute group
  • Associating application with a stack

The @aws-cdk/aws-servicecatalogappregistry package contains resources that enable users to automate governance and management of their AWS resources at scale.

 import software.amazon.awscdk.core.*;
 

Application

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.

 // Example automatically generated from non-compiling source. May contain errors.
 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 Application.fromApplicationArn() API:

 // Example automatically generated from non-compiling source. May contain errors.
 IApplication importedApplication = Application.fromApplicationArn(this, "MyImportedApplication", "arn:aws:servicecatalog:us-east-1:012345678910:/applications/0aqmvxvgmry0ecc4mjhwypun6i");
 

Attribute Group

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.

 // Example automatically generated from non-compiling source. May contain errors.
 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 AttributeGroup.fromAttributeGroupArn() API:

 // Example automatically generated from non-compiling source. May contain errors.
 IAttributeGroup importedAttributeGroup = AttributeGroup.fromAttributeGroupArn(this, "MyImportedAttrGroup", "arn:aws:servicecatalog:us-east-1:012345678910:/attribute-groups/0aqmvxvgmry0ecc4mjhwypun6i");
 

Associations

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 associateAttributeGroup() API:

 // Example automatically generated from non-compiling source. May contain errors.
 application.associateAttributeGroup(attributeGroup);
 

Associating application with a Stack

You can associate a stack with an application with the associateStack() API:

 // Example automatically generated from non-compiling source. May contain errors.
 Stack myStack = new Stack(app, "MyStack");
 
 application.associateStack(myStack);