# AWS ServiceCatalogAppRegistry Construct Library
<!--BEGIN STABILITY BANNER-->---
> 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](https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html).
---
<!--END STABILITY BANNER-->
[AWS Service Catalog App Registry](https://docs.aws.amazon.com/servicecatalog/latest/adminguide/appregistry.html)
enables organizations to create and manage repositores of applications and associated resources.
## Table Of Contents
* [Application](#application)
* [Attribute-Group](#attribute-group)
* [Associations](#associations)
* [Associating application with an attribute group](#attribute-group-association)
* [Associating application with a stack](#resource-association)
The `@aws-cdk/aws-servicecatalogappregistry` package contains resources that enable users to automate governance and management of their AWS resources at scale.
```python
import aws_cdk.aws_servicecatalogappregistry as appreg
```
## 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.
```python
application = appreg.Application(self, "MyFirstApplication",
application_name="MyFirstApplicationName",
description="description for my application"
)
```
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:
```python
imported_application = appreg.Application.from_application_arn(self, "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.
```python
attribute_group = appreg.AttributeGroup(self, "MyFirstAttributeGroup",
attribute_group_name="MyFirstAttributeGroupName",
description="description for my attribute group", # the description is optional,
attributes={
"project": "foo",
"team": ["member1", "member2", "member3"],
"public": False,
"stages": {
"alpha": "complete",
"beta": "incomplete",
"release": "not started"
}
}
)
```
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:
```python
imported_attribute_group = appreg.AttributeGroup.from_attribute_group_arn(self, "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:
```python
# application: appreg.Application
# attribute_group: appreg.AttributeGroup
application.associate_attribute_group(attribute_group)
```
### Associating application with a Stack
You can associate a stack with an application with the `associateStack()` API:
```python
# application: appreg.Application
app = App()
my_stack = Stack(app, "MyStack")
application.associate_stack(my_stack)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/aws/aws-cdk",
"name": "aws-cdk.aws-servicecatalogappregistry",
"maintainer": "",
"docs_url": null,
"requires_python": "~=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Amazon Web Services",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/ca/28/a606e30535aaafb80adce2906b2e91b5aac4313984b6fdf5f424d112f12a/aws-cdk.aws-servicecatalogappregistry-1.204.0.tar.gz",
"platform": null,
"description": "# AWS ServiceCatalogAppRegistry Construct Library\n\n<!--BEGIN STABILITY BANNER-->---\n\n\n\n\n> AWS CDK v1 has reached End-of-Support on 2023-06-01.\n> This package is no longer being updated, and users should migrate to AWS CDK v2.\n>\n> For more information on how to migrate, see the [*Migrating to AWS CDK v2* guide](https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html).\n\n---\n<!--END STABILITY BANNER-->\n\n[AWS Service Catalog App Registry](https://docs.aws.amazon.com/servicecatalog/latest/adminguide/appregistry.html)\nenables organizations to create and manage repositores of applications and associated resources.\n\n## Table Of Contents\n\n* [Application](#application)\n* [Attribute-Group](#attribute-group)\n* [Associations](#associations)\n\n * [Associating application with an attribute group](#attribute-group-association)\n * [Associating application with a stack](#resource-association)\n\nThe `@aws-cdk/aws-servicecatalogappregistry` package contains resources that enable users to automate governance and management of their AWS resources at scale.\n\n```python\nimport aws_cdk.aws_servicecatalogappregistry as appreg\n```\n\n## Application\n\nAn AppRegistry application enables you to define your applications and associated resources.\nThe application name must be unique at the account level, but is mutable.\n\n```python\napplication = appreg.Application(self, \"MyFirstApplication\",\n application_name=\"MyFirstApplicationName\",\n description=\"description for my application\"\n)\n```\n\nAn application that has been created outside of the stack can be imported into your CDK app.\nApplications can be imported by their ARN via the `Application.fromApplicationArn()` API:\n\n```python\nimported_application = appreg.Application.from_application_arn(self, \"MyImportedApplication\", \"arn:aws:servicecatalog:us-east-1:012345678910:/applications/0aqmvxvgmry0ecc4mjhwypun6i\")\n```\n\n## Attribute Group\n\nAn AppRegistry attribute group acts as a container for user-defined attributes for an application.\nMetadata is attached in a machine-readble format to integrate with automated workflows and tools.\n\n```python\nattribute_group = appreg.AttributeGroup(self, \"MyFirstAttributeGroup\",\n attribute_group_name=\"MyFirstAttributeGroupName\",\n description=\"description for my attribute group\", # the description is optional,\n attributes={\n \"project\": \"foo\",\n \"team\": [\"member1\", \"member2\", \"member3\"],\n \"public\": False,\n \"stages\": {\n \"alpha\": \"complete\",\n \"beta\": \"incomplete\",\n \"release\": \"not started\"\n }\n }\n)\n```\n\nAn attribute group that has been created outside of the stack can be imported into your CDK app.\nAttribute groups can be imported by their ARN via the `AttributeGroup.fromAttributeGroupArn()` API:\n\n```python\nimported_attribute_group = appreg.AttributeGroup.from_attribute_group_arn(self, \"MyImportedAttrGroup\", \"arn:aws:servicecatalog:us-east-1:012345678910:/attribute-groups/0aqmvxvgmry0ecc4mjhwypun6i\")\n```\n\n## Associations\n\nYou can associate your appregistry application with attribute groups and resources.\nResources are CloudFormation stacks that you can associate with an application to group relevant\nstacks together to enable metadata rich insights into your applications and resources.\nA Cloudformation stack can only be associated with one appregistry application.\nIf a stack is associated with multiple applications in your app or is already associated with one,\nCDK will fail at deploy time.\n\n### Associating application with an attribute group\n\nYou can associate an attribute group with an application with the `associateAttributeGroup()` API:\n\n```python\n# application: appreg.Application\n# attribute_group: appreg.AttributeGroup\n\napplication.associate_attribute_group(attribute_group)\n```\n\n### Associating application with a Stack\n\nYou can associate a stack with an application with the `associateStack()` API:\n\n```python\n# application: appreg.Application\napp = App()\nmy_stack = Stack(app, \"MyStack\")\napplication.associate_stack(my_stack)\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "The CDK Construct Library for AWS::ServiceCatalogAppRegistry",
"version": "1.204.0",
"project_urls": {
"Homepage": "https://github.com/aws/aws-cdk",
"Source": "https://github.com/aws/aws-cdk.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4be0c190f0d58f6c1196e183298612dd663edb70669f3b6871f69b28bc28ed25",
"md5": "67bd18b6b6be6914e40aa535cc656503",
"sha256": "7a0db12064f7fe0dde50fc1fad91f1f0d9e2634ab6c8d4cbc7a939313343d3d9"
},
"downloads": -1,
"filename": "aws_cdk.aws_servicecatalogappregistry-1.204.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "67bd18b6b6be6914e40aa535cc656503",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.7",
"size": 67937,
"upload_time": "2023-06-19T21:01:19",
"upload_time_iso_8601": "2023-06-19T21:01:19.074447Z",
"url": "https://files.pythonhosted.org/packages/4b/e0/c190f0d58f6c1196e183298612dd663edb70669f3b6871f69b28bc28ed25/aws_cdk.aws_servicecatalogappregistry-1.204.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ca28a606e30535aaafb80adce2906b2e91b5aac4313984b6fdf5f424d112f12a",
"md5": "81fdedf1443364745236b778ff67215b",
"sha256": "0cbfd9b92eef066e593003d2cea25d2e565b8f6d09879cfa636f44210ab93ca7"
},
"downloads": -1,
"filename": "aws-cdk.aws-servicecatalogappregistry-1.204.0.tar.gz",
"has_sig": false,
"md5_digest": "81fdedf1443364745236b778ff67215b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.7",
"size": 69077,
"upload_time": "2023-06-19T21:07:24",
"upload_time_iso_8601": "2023-06-19T21:07:24.242886Z",
"url": "https://files.pythonhosted.org/packages/ca/28/a606e30535aaafb80adce2906b2e91b5aac4313984b6fdf5f424d112f12a/aws-cdk.aws-servicecatalogappregistry-1.204.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-19 21:07:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aws",
"github_project": "aws-cdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aws-cdk.aws-servicecatalogappregistry"
}
JSON
