@aws-cdk/aws-servicecatalogappregistry-alpha 2.69.0-alpha.0 → 2.71.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +317 -70
- package/.jsii.tabl.json.gz +0 -0
- package/.warnings.jsii.js +3 -1
- package/README.md +23 -17
- package/lib/application-associator.d.ts +5 -2
- package/lib/application-associator.js +15 -7
- package/lib/application.d.ts +34 -1
- package/lib/application.js +23 -4
- package/lib/aspects/stack-associator.d.ts +14 -3
- package/lib/aspects/stack-associator.js +27 -13
- package/lib/attribute-group.js +1 -1
- package/lib/target-application.d.ts +12 -1
- package/lib/target-application.js +4 -2
- package/package.json +8 -8
package/.jsii
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"url": "https://aws.amazon.com"
|
|
9
9
|
},
|
|
10
10
|
"dependencies": {
|
|
11
|
-
"aws-cdk-lib": "^2.
|
|
11
|
+
"aws-cdk-lib": "^2.71.0",
|
|
12
12
|
"constructs": "^10.0.0"
|
|
13
13
|
},
|
|
14
14
|
"dependencyClosure": {
|
|
@@ -782,6 +782,19 @@
|
|
|
782
782
|
}
|
|
783
783
|
}
|
|
784
784
|
},
|
|
785
|
+
"aws-cdk-lib.aws_comprehend": {
|
|
786
|
+
"targets": {
|
|
787
|
+
"dotnet": {
|
|
788
|
+
"namespace": "Amazon.CDK.AWS.Comprehend"
|
|
789
|
+
},
|
|
790
|
+
"java": {
|
|
791
|
+
"package": "software.amazon.awscdk.services.comprehend"
|
|
792
|
+
},
|
|
793
|
+
"python": {
|
|
794
|
+
"module": "aws_cdk.aws_comprehend"
|
|
795
|
+
}
|
|
796
|
+
}
|
|
797
|
+
},
|
|
785
798
|
"aws-cdk-lib.aws_config": {
|
|
786
799
|
"targets": {
|
|
787
800
|
"dotnet": {
|
|
@@ -1575,6 +1588,19 @@
|
|
|
1575
1588
|
}
|
|
1576
1589
|
}
|
|
1577
1590
|
},
|
|
1591
|
+
"aws-cdk-lib.aws_internetmonitor": {
|
|
1592
|
+
"targets": {
|
|
1593
|
+
"dotnet": {
|
|
1594
|
+
"namespace": "Amazon.CDK.AWS.InternetMonitor"
|
|
1595
|
+
},
|
|
1596
|
+
"java": {
|
|
1597
|
+
"package": "software.amazon.awscdk.services.internetmonitor"
|
|
1598
|
+
},
|
|
1599
|
+
"python": {
|
|
1600
|
+
"module": "aws_cdk.aws_internetmonitor"
|
|
1601
|
+
}
|
|
1602
|
+
}
|
|
1603
|
+
},
|
|
1578
1604
|
"aws-cdk-lib.aws_iot": {
|
|
1579
1605
|
"targets": {
|
|
1580
1606
|
"dotnet": {
|
|
@@ -1731,6 +1757,19 @@
|
|
|
1731
1757
|
}
|
|
1732
1758
|
}
|
|
1733
1759
|
},
|
|
1760
|
+
"aws-cdk-lib.aws_ivschat": {
|
|
1761
|
+
"targets": {
|
|
1762
|
+
"dotnet": {
|
|
1763
|
+
"namespace": "Amazon.CDK.AWS.IVSChat"
|
|
1764
|
+
},
|
|
1765
|
+
"java": {
|
|
1766
|
+
"package": "software.amazon.awscdk.services.ivschat"
|
|
1767
|
+
},
|
|
1768
|
+
"python": {
|
|
1769
|
+
"module": "aws_cdk.aws_ivschat"
|
|
1770
|
+
}
|
|
1771
|
+
}
|
|
1772
|
+
},
|
|
1734
1773
|
"aws-cdk-lib.aws_kafkaconnect": {
|
|
1735
1774
|
"targets": {
|
|
1736
1775
|
"dotnet": {
|
|
@@ -3044,6 +3083,19 @@
|
|
|
3044
3083
|
}
|
|
3045
3084
|
}
|
|
3046
3085
|
},
|
|
3086
|
+
"aws-cdk-lib.aws_systemsmanagersap": {
|
|
3087
|
+
"targets": {
|
|
3088
|
+
"dotnet": {
|
|
3089
|
+
"namespace": "Amazon.CDK.AWS.SystemsManagerSAP"
|
|
3090
|
+
},
|
|
3091
|
+
"java": {
|
|
3092
|
+
"package": "software.amazon.awscdk.services.systemsmanagersap"
|
|
3093
|
+
},
|
|
3094
|
+
"python": {
|
|
3095
|
+
"module": "aws_cdk.aws_systemsmanagersap"
|
|
3096
|
+
}
|
|
3097
|
+
}
|
|
3098
|
+
},
|
|
3047
3099
|
"aws-cdk-lib.aws_timestream": {
|
|
3048
3100
|
"targets": {
|
|
3049
3101
|
"dotnet": {
|
|
@@ -3083,6 +3135,19 @@
|
|
|
3083
3135
|
}
|
|
3084
3136
|
}
|
|
3085
3137
|
},
|
|
3138
|
+
"aws-cdk-lib.aws_vpclattice": {
|
|
3139
|
+
"targets": {
|
|
3140
|
+
"dotnet": {
|
|
3141
|
+
"namespace": "Amazon.CDK.AWS.VpcLattice"
|
|
3142
|
+
},
|
|
3143
|
+
"java": {
|
|
3144
|
+
"package": "software.amazon.awscdk.services.vpclattice"
|
|
3145
|
+
},
|
|
3146
|
+
"python": {
|
|
3147
|
+
"module": "aws_cdk.aws_vpclattice"
|
|
3148
|
+
}
|
|
3149
|
+
}
|
|
3150
|
+
},
|
|
3086
3151
|
"aws-cdk-lib.aws_waf": {
|
|
3087
3152
|
"targets": {
|
|
3088
3153
|
"dotnet": {
|
|
@@ -3371,7 +3436,7 @@
|
|
|
3371
3436
|
},
|
|
3372
3437
|
"name": "@aws-cdk/aws-servicecatalogappregistry-alpha",
|
|
3373
3438
|
"readme": {
|
|
3374
|
-
"markdown": "# AWS ServiceCatalogAppRegistry Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\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 repositories of applications and associated resources.\n\n## Table Of Contents\n\n- [Application](#application)\n- [Application-Associator](#application-associator)\n- [Attribute-Group](#attribute-group)\n- [Associations](#associations)\n - [Associating application with an attribute group](#attribute-group-association)\n - [Associating application with a stack](#resource-association)\n- [Sharing](#sharing)\n - [Sharing an application](#sharing-an-application)\n - [Sharing an attribute group](#sharing-an-attribute-group)\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```ts nofixture\nimport * as appreg from '@aws-cdk/aws-servicecatalogappregistry-alpha';\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 and it's immutable.\n\n```ts\nconst application = new appreg.Application(this, 'MyFirstApplication', {\n applicationName: 'MyFirstApplicationName',\n description: 'description for my application', // the description is optional\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```ts\nconst importedApplication = appreg.Application.fromApplicationArn(\n this,\n 'MyImportedApplication',\n 'arn:aws:servicecatalog:us-east-1:012345678910:/applications/0aqmvxvgmry0ecc4mjhwypun6i',\n);\n```\n\n## Application-Associator\n\nIf you want to create an Application named `MyAssociatedApplication` in account `123456789012` and region `us-east-1`\nand want to associate all stacks in the `App` scope to `MyAssociatedApplication`, then use as shown in the example below:\n\n```ts\nconst app = new App();\nconst associatedApp = new appreg.ApplicationAssociator(app, 'AssociatedApplication', {\n applications: [appreg.TargetApplication.createApplicationStack({\n applicationName: 'MyAssociatedApplication',\n // 'Application containing stacks deployed via CDK.' is the default\n applicationDescription: 'Associated Application description',\n stackName: 'MyAssociatedApplicationStack',\n // AWS Account and Region that are implied by the current CLI configuration is the default\n env: { account: '123456789012', region: 'us-east-1' },\n })],\n});\n```\n\nThis will create a stack `MyAssociatedApplicationStack` containing an application `MyAssociatedApplication`\nwith the `TagKey` as `managedBy` and `TagValue` as `CDK_Application_Associator`.\n\nBy default, the stack will have System Managed Application Manager console URL as its output for the application created.\nIf you want to remove the output, then use as shown in the example below:\n\n```ts\nconst app = new App();\nconst associatedApp = new appreg.ApplicationAssociator(app, 'AssociatedApplication', {\n applications: [appreg.TargetApplication.createApplicationStack({\n applicationName: 'MyAssociatedApplication',\n // 'Application containing stacks deployed via CDK.' is the default\n applicationDescription: 'Associated Application description',\n stackName: 'MyAssociatedApplicationStack',\n // Disables emitting Application Manager url as output\n emitApplicationManagerUrlAsOutput: false,\n // AWS Account and Region that are implied by the current CLI configuration is the default\n env: { account: '123456789012', region: 'us-east-1' },\n })],\n});\n```\n\nIf you want to re-use an existing Application with ARN: `arn:aws:servicecatalog:us-east-1:123456789012:/applications/applicationId`\nand want to associate all stacks in the `App` scope to your imported application, then use as shown in the example below:\n\n```ts\nconst app = new App();\nconst associatedApp = new appreg.ApplicationAssociator(app, 'AssociatedApplication', {\n applications: [appreg.TargetApplication.existingApplicationFromArn({\n applicationArnValue: 'arn:aws:servicecatalog:us-east-1:123456789012:/applications/applicationId',\n stackName: 'MyAssociatedApplicationStack',\n })],\n});\n```\n\nIf you want to associate an Attribute Group with application created by `ApplicationAssociator`, then use as shown in the example below:\n\n```ts\nimport * as cdk from \"aws-cdk-lib\";\n\nconst app = new App();\n\nclass CustomAppRegistryAttributeGroup extends cdk.Stack {\n public readonly attributeGroup: appreg.AttributeGroup\n constructor(scope: Construct, id: string, props?: cdk.StackProps) {\n super(scope, id, props);\n const myAttributeGroup = new appreg.AttributeGroup(app, 'MyFirstAttributeGroup', {\n attributeGroupName: 'MyAttributeGroupName',\n description: 'Test attribute group',\n attributes: {},\n });\n\n this.attributeGroup = myAttributeGroup;\n }\n}\n\nconst customAttributeGroup = new CustomAppRegistryAttributeGroup(app, 'AppRegistryAttributeGroup');\n\nconst associatedApp = new appreg.ApplicationAssociator(app, 'AssociatedApplication', {\n applications: [appreg.TargetApplication.createApplicationStack({\n applicationName: 'MyAssociatedApplication',\n // 'Application containing stacks deployed via CDK.' is the default\n applicationDescription: 'Associated Application description',\n stackName: 'MyAssociatedApplicationStack',\n // AWS Account and Region that are implied by the current CLI configuration is the default\n env: { account: '123456789012', region: 'us-east-1' },\n })],\n});\n\n// Associate application to the attribute group.\ncustomAttributeGroup.attributeGroup.associateWith(associatedApp.appRegistryApplication());\n\n```\n\nIf you are using CDK Pipelines to deploy your application, the application stacks will be inside Stages, and\nApplicationAssociator will not be able to find them. Call `associateStage` on each Stage object before adding it to the\nPipeline, as shown in the example below:\n\n```ts\nimport * as cdk from \"aws-cdk-lib\";\nimport * as codepipeline from \"aws-cdk-lib/pipelines\";\nimport * as codecommit from \"aws-cdk-lib/aws-codecommit\";\ndeclare const repo: codecommit.Repository;\ndeclare const pipeline: codepipeline.CodePipeline;\ndeclare const beta: cdk.Stage;\nclass ApplicationPipelineStack extends cdk.Stack {\n constructor(scope: cdk.App, id: string, props: ApplicationPipelineStackProps) {\n super(scope, id, props);\n\n //associate the stage to application associator.\n props.application.associateStage(beta);\n pipeline.addStage(beta);\n }\n};\n\ninterface ApplicationPipelineStackProps extends cdk.StackProps {\n application: appreg.ApplicationAssociator;\n};\n\nconst app = new App();\nconst associatedApp = new appreg.ApplicationAssociator(app, 'AssociatedApplication', {\n applications: [appreg.TargetApplication.createApplicationStack({\n applicationName: 'MyPipelineAssociatedApplication',\n stackName: 'MyPipelineAssociatedApplicationStack',\n env: { account: '123456789012', region: 'us-east-1' },\n })],\n});\n\nconst cdkPipeline = new ApplicationPipelineStack(app, 'CDKApplicationPipelineStack', {\n application: associatedApp,\n env: {account: '123456789012', region: 'us-east-1'},\n});\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-readable format to integrate with automated workflows and tools.\n\n```ts\nconst attributeGroup = new appreg.AttributeGroup(this, 'MyFirstAttributeGroup', {\n attributeGroupName: '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```ts\nconst importedAttributeGroup = appreg.AttributeGroup.fromAttributeGroupArn(\n this,\n 'MyImportedAttrGroup',\n 'arn:aws:servicecatalog:us-east-1:012345678910:/attribute-groups/0aqmvxvgmry0ecc4mjhwypun6i',\n);\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```ts\ndeclare const application: appreg.Application;\ndeclare const attributeGroup: appreg.AttributeGroup;\napplication.associateAttributeGroup(attributeGroup);\n```\n\n### Associating an attribute group with application\n\nYou can associate an application with an attribute group with `associateWith`:\n\n```ts\ndeclare const application: appreg.Application;\ndeclare const attributeGroup: appreg.AttributeGroup;\nattributeGroup.associateWith(application);\n```\n\n### Associating application with a Stack\n\nYou can associate a stack with an application with the `associateStack()` API:\n\n```ts\nconst app = new App();\nconst myStack = new Stack(app, 'MyStack');\n\ndeclare const application: appreg.Application;\napplication.associateStack(myStack);\n```\n\n## Sharing\n\nYou can share your AppRegistry applications and attribute groups with AWS Organizations, Organizational Units (OUs), AWS accounts within an organization, as well as IAM roles and users. AppRegistry requires that AWS Organizations is enabled in an account before deploying a share of an application or attribute group.\n\n### Sharing an application\n\n```ts\nimport * as iam from 'aws-cdk-lib/aws-iam';\ndeclare const application: appreg.Application;\ndeclare const myRole: iam.IRole;\ndeclare const myUser: iam.IUser;\napplication.shareApplication({\n accounts: ['123456789012'],\n organizationArns: ['arn:aws:organizations::123456789012:organization/o-my-org-id'],\n roles: [myRole],\n users: [myUser],\n});\n```\n\nE.g., sharing an application with multiple accounts and allowing the accounts to associate resources to the application.\n\n```ts\nimport * as iam from 'aws-cdk-lib/aws-iam';\ndeclare const application: appreg.Application;\napplication.shareApplication({\n accounts: ['123456789012', '234567890123'],\n sharePermission: appreg.SharePermission.ALLOW_ACCESS,\n});\n```\n\n### Sharing an attribute group\n\n```ts\nimport * as iam from 'aws-cdk-lib/aws-iam';\ndeclare const attributeGroup: appreg.AttributeGroup;\ndeclare const myRole: iam.IRole;\ndeclare const myUser: iam.IUser;\nattributeGroup.shareAttributeGroup({\n accounts: ['123456789012'],\n organizationArns: ['arn:aws:organizations::123456789012:organization/o-my-org-id'],\n roles: [myRole],\n users: [myUser],\n});\n```\n\nE.g., sharing an application with multiple accounts and allowing the accounts to associate applications to the attribute group.\n\n```ts\nimport * as iam from 'aws-cdk-lib/aws-iam';\ndeclare const attributeGroup: appreg.AttributeGroup;\nattributeGroup.shareAttributeGroup({\n accounts: ['123456789012', '234567890123'],\n sharePermission: appreg.SharePermission.ALLOW_ACCESS,\n});\n```\n"
|
|
3439
|
+
"markdown": "# AWS ServiceCatalogAppRegistry Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\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 repositories of applications and associated resources.\n\n## Table Of Contents\n\n- [Application](#application)\n- [Application-Associator](#application-associator)\n- [Attribute-Group](#attribute-group)\n- [Associations](#associations)\n - [Associating application with an attribute group](#attribute-group-association)\n - [Associating application with a stack](#resource-association)\n- [Sharing](#sharing)\n - [Sharing an application](#sharing-an-application)\n - [Sharing an attribute group](#sharing-an-attribute-group)\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```ts nofixture\nimport * as appreg from '@aws-cdk/aws-servicecatalogappregistry-alpha';\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 and it's immutable.\n\n```ts\nconst application = new appreg.Application(this, 'MyFirstApplication', {\n applicationName: 'MyFirstApplicationName',\n description: 'description for my application', // the description is optional\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```ts\nconst importedApplication = appreg.Application.fromApplicationArn(\n this,\n 'MyImportedApplication',\n 'arn:aws:servicecatalog:us-east-1:012345678910:/applications/0aqmvxvgmry0ecc4mjhwypun6i',\n);\n```\n\n## Application-Associator\n\nIf you want to create an Application named `MyAssociatedApplication` in account `123456789012` and region `us-east-1`\nand want to associate all stacks in the `App` scope to `MyAssociatedApplication`, then use as shown in the example below:\n\n```ts\nconst app = new App();\nconst associatedApp = new appreg.ApplicationAssociator(app, 'AssociatedApplication', {\n applications: [appreg.TargetApplication.createApplicationStack({\n applicationName: 'MyAssociatedApplication',\n // 'Application containing stacks deployed via CDK.' is the default\n applicationDescription: 'Associated Application description',\n stackName: 'MyAssociatedApplicationStack',\n // AWS Account and Region that are implied by the current CLI configuration is the default\n env: { account: '123456789012', region: 'us-east-1' },\n })],\n});\n```\n\nThis will create a stack `MyAssociatedApplicationStack` containing an application `MyAssociatedApplication`\nwith the `TagKey` as `managedBy` and `TagValue` as `CDK_Application_Associator`.\n\nBy default, the stack will have System Managed Application Manager console URL as its output for the application created.\nIf you want to remove the output, then use as shown in the example below:\n\n```ts\nconst app = new App();\nconst associatedApp = new appreg.ApplicationAssociator(app, 'AssociatedApplication', {\n applications: [appreg.TargetApplication.createApplicationStack({\n applicationName: 'MyAssociatedApplication',\n // 'Application containing stacks deployed via CDK.' is the default\n applicationDescription: 'Associated Application description',\n stackName: 'MyAssociatedApplicationStack',\n // Disables emitting Application Manager url as output\n emitApplicationManagerUrlAsOutput: false,\n // AWS Account and Region that are implied by the current CLI configuration is the default\n env: { account: '123456789012', region: 'us-east-1' },\n })],\n});\n```\n\nIf you want to re-use an existing Application with ARN: `arn:aws:servicecatalog:us-east-1:123456789012:/applications/applicationId`\nand want to associate all stacks in the `App` scope to your imported application, then use as shown in the example below:\n\n```ts\nconst app = new App();\nconst associatedApp = new appreg.ApplicationAssociator(app, 'AssociatedApplication', {\n applications: [appreg.TargetApplication.existingApplicationFromArn({\n applicationArnValue: 'arn:aws:servicecatalog:us-east-1:123456789012:/applications/applicationId',\n stackName: 'MyAssociatedApplicationStack',\n })],\n});\n```\n\nIf you want to associate an Attribute Group with application created by `ApplicationAssociator`, then use as shown in the example below:\n\n```ts\nimport * as cdk from \"aws-cdk-lib\";\n\nconst app = new App();\n\nconst associatedApp = new appreg.ApplicationAssociator(app, 'AssociatedApplication', {\n applications: [appreg.TargetApplication.createApplicationStack({\n applicationName: 'MyAssociatedApplication',\n // 'Application containing stacks deployed via CDK.' is the default\n applicationDescription: 'Associated Application description',\n stackName: 'MyAssociatedApplicationStack',\n // AWS Account and Region that are implied by the current CLI configuration is the default\n env: { account: '123456789012', region: 'us-east-1' },\n })],\n});\n\n// Associate application to the attribute group.\nassociatedApp.appRegistryApplication.addAttributeGroup('MyAttributeGroup' , {\n attributeGroupName: 'MyAttributeGroupName',\n description: 'Test attribute group',\n attributes: {},\n});\n\n```\n\nIf you are using CDK Pipelines to deploy your application, the application stacks will be inside Stages, and\nApplicationAssociator will not be able to find them. Call `associateStage` on each Stage object before adding it to the\nPipeline, as shown in the example below:\n\n```ts\nimport * as cdk from \"aws-cdk-lib\";\nimport * as codepipeline from \"aws-cdk-lib/pipelines\";\nimport * as codecommit from \"aws-cdk-lib/aws-codecommit\";\ndeclare const repo: codecommit.Repository;\ndeclare const pipeline: codepipeline.CodePipeline;\ndeclare const beta: cdk.Stage;\nclass ApplicationPipelineStack extends cdk.Stack {\n constructor(scope: cdk.App, id: string, props: ApplicationPipelineStackProps) {\n super(scope, id, props);\n\n //associate the stage to application associator.\n props.application.associateStage(beta);\n pipeline.addStage(beta);\n }\n};\n\ninterface ApplicationPipelineStackProps extends cdk.StackProps {\n application: appreg.ApplicationAssociator;\n};\n\nconst app = new App();\nconst associatedApp = new appreg.ApplicationAssociator(app, 'AssociatedApplication', {\n applications: [appreg.TargetApplication.createApplicationStack({\n applicationName: 'MyPipelineAssociatedApplication',\n stackName: 'MyPipelineAssociatedApplicationStack',\n env: { account: '123456789012', region: 'us-east-1' },\n })],\n});\n\nconst cdkPipeline = new ApplicationPipelineStack(app, 'CDKApplicationPipelineStack', {\n application: associatedApp,\n env: {account: '123456789012', region: 'us-east-1'},\n});\n```\n\nBy default, ApplicationAssociator will not perform cross-account stack associations with the target Application,\nto avoid deployment failures for accounts which have not been setup for cross-account associations.\nTo enable cross-account stack associations, make sure all accounts are in the same organization as the\ntarget Application's account and that resource sharing is enabled within the organization.\nIf you wish to turn on cross-account sharing and associations, set the `associateCrossAccountStacks` field to `true`,\nas shown in the example below:\n\n```ts\nconst app = new App();\nconst associatedApp = new appreg.ApplicationAssociator(app, 'AssociatedApplication', {\n applications: [appreg.TargetApplication.createApplicationStack({\n associateCrossAccountStacks: true,\n applicationName: 'MyAssociatedApplication',\n env: { account: '123456789012', region: 'us-east-1' },\n })],\n});\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-readable format to integrate with automated workflows and tools.\n\n```ts\nconst attributeGroup = new appreg.AttributeGroup(this, 'MyFirstAttributeGroup', {\n attributeGroupName: '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```ts\nconst importedAttributeGroup = appreg.AttributeGroup.fromAttributeGroupArn(\n this,\n 'MyImportedAttrGroup',\n 'arn:aws:servicecatalog:us-east-1:012345678910:/attribute-groups/0aqmvxvgmry0ecc4mjhwypun6i',\n);\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```ts\ndeclare const application: appreg.Application;\ndeclare const attributeGroup: appreg.AttributeGroup;\napplication.associateAttributeGroup(attributeGroup);\n```\n\n### Associating an attribute group with application\n\nYou can associate an application with an attribute group with `associateWith`:\n\n```ts\ndeclare const application: appreg.Application;\ndeclare const attributeGroup: appreg.AttributeGroup;\nattributeGroup.associateWith(application);\n```\n\n### Associating application with a Stack\n\nYou can associate a stack with an application with the `associateStack()` API:\n\n```ts\nconst app = new App();\nconst myStack = new Stack(app, 'MyStack');\n\ndeclare const application: appreg.Application;\napplication.associateStack(myStack);\n```\n\n## Sharing\n\nYou can share your AppRegistry applications and attribute groups with AWS Organizations, Organizational Units (OUs), AWS accounts within an organization, as well as IAM roles and users. AppRegistry requires that AWS Organizations is enabled in an account before deploying a share of an application or attribute group.\n\n### Sharing an application\n\n```ts\nimport * as iam from 'aws-cdk-lib/aws-iam';\ndeclare const application: appreg.Application;\ndeclare const myRole: iam.IRole;\ndeclare const myUser: iam.IUser;\napplication.shareApplication({\n accounts: ['123456789012'],\n organizationArns: ['arn:aws:organizations::123456789012:organization/o-my-org-id'],\n roles: [myRole],\n users: [myUser],\n});\n```\n\nE.g., sharing an application with multiple accounts and allowing the accounts to associate resources to the application.\n\n```ts\nimport * as iam from 'aws-cdk-lib/aws-iam';\ndeclare const application: appreg.Application;\napplication.shareApplication({\n accounts: ['123456789012', '234567890123'],\n sharePermission: appreg.SharePermission.ALLOW_ACCESS,\n});\n```\n\n### Sharing an attribute group\n\n```ts\nimport * as iam from 'aws-cdk-lib/aws-iam';\ndeclare const attributeGroup: appreg.AttributeGroup;\ndeclare const myRole: iam.IRole;\ndeclare const myUser: iam.IUser;\nattributeGroup.shareAttributeGroup({\n accounts: ['123456789012'],\n organizationArns: ['arn:aws:organizations::123456789012:organization/o-my-org-id'],\n roles: [myRole],\n users: [myUser],\n});\n```\n\nE.g., sharing an application with multiple accounts and allowing the accounts to associate applications to the attribute group.\n\n```ts\nimport * as iam from 'aws-cdk-lib/aws-iam';\ndeclare const attributeGroup: appreg.AttributeGroup;\nattributeGroup.shareAttributeGroup({\n accounts: ['123456789012', '234567890123'],\n sharePermission: appreg.SharePermission.ALLOW_ACCESS,\n});\n```\n"
|
|
3375
3440
|
},
|
|
3376
3441
|
"repository": {
|
|
3377
3442
|
"directory": "packages/individual-packages/aws-servicecatalogappregistry",
|
|
@@ -3429,7 +3494,7 @@
|
|
|
3429
3494
|
},
|
|
3430
3495
|
"locationInModule": {
|
|
3431
3496
|
"filename": "lib/application.ts",
|
|
3432
|
-
"line":
|
|
3497
|
+
"line": 315
|
|
3433
3498
|
},
|
|
3434
3499
|
"parameters": [
|
|
3435
3500
|
{
|
|
@@ -3458,7 +3523,7 @@
|
|
|
3458
3523
|
"kind": "class",
|
|
3459
3524
|
"locationInModule": {
|
|
3460
3525
|
"filename": "lib/application.ts",
|
|
3461
|
-
"line":
|
|
3526
|
+
"line": 274
|
|
3462
3527
|
},
|
|
3463
3528
|
"methods": [
|
|
3464
3529
|
{
|
|
@@ -3468,7 +3533,7 @@
|
|
|
3468
3533
|
},
|
|
3469
3534
|
"locationInModule": {
|
|
3470
3535
|
"filename": "lib/application.ts",
|
|
3471
|
-
"line":
|
|
3536
|
+
"line": 282
|
|
3472
3537
|
},
|
|
3473
3538
|
"name": "fromApplicationArn",
|
|
3474
3539
|
"parameters": [
|
|
@@ -3507,15 +3572,46 @@
|
|
|
3507
3572
|
},
|
|
3508
3573
|
"static": true
|
|
3509
3574
|
},
|
|
3575
|
+
{
|
|
3576
|
+
"docs": {
|
|
3577
|
+
"stability": "experimental",
|
|
3578
|
+
"summary": "Create an attribute group and associate this application with the created attribute group."
|
|
3579
|
+
},
|
|
3580
|
+
"locationInModule": {
|
|
3581
|
+
"filename": "lib/application.ts",
|
|
3582
|
+
"line": 151
|
|
3583
|
+
},
|
|
3584
|
+
"name": "addAttributeGroup",
|
|
3585
|
+
"overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication",
|
|
3586
|
+
"parameters": [
|
|
3587
|
+
{
|
|
3588
|
+
"name": "id",
|
|
3589
|
+
"type": {
|
|
3590
|
+
"primitive": "string"
|
|
3591
|
+
}
|
|
3592
|
+
},
|
|
3593
|
+
{
|
|
3594
|
+
"name": "props",
|
|
3595
|
+
"type": {
|
|
3596
|
+
"fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.AttributeGroupAssociationProps"
|
|
3597
|
+
}
|
|
3598
|
+
}
|
|
3599
|
+
],
|
|
3600
|
+
"returns": {
|
|
3601
|
+
"type": {
|
|
3602
|
+
"fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.IAttributeGroup"
|
|
3603
|
+
}
|
|
3604
|
+
}
|
|
3605
|
+
},
|
|
3510
3606
|
{
|
|
3511
3607
|
"docs": {
|
|
3512
3608
|
"remarks": "NOTE: This method won't automatically register stacks under pipeline stages,\nand requires association of each pipeline stage by calling this method with stage Construct.",
|
|
3513
3609
|
"stability": "experimental",
|
|
3514
|
-
"summary": "Associate all stacks present in construct's aspect with application."
|
|
3610
|
+
"summary": "Associate all stacks present in construct's aspect with application, including cross-account stacks."
|
|
3515
3611
|
},
|
|
3516
3612
|
"locationInModule": {
|
|
3517
3613
|
"filename": "lib/application.ts",
|
|
3518
|
-
"line":
|
|
3614
|
+
"line": 229
|
|
3519
3615
|
},
|
|
3520
3616
|
"name": "associateAllStacksInScope",
|
|
3521
3617
|
"overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication",
|
|
@@ -3536,7 +3632,7 @@
|
|
|
3536
3632
|
},
|
|
3537
3633
|
"locationInModule": {
|
|
3538
3634
|
"filename": "lib/application.ts",
|
|
3539
|
-
"line":
|
|
3635
|
+
"line": 189
|
|
3540
3636
|
},
|
|
3541
3637
|
"name": "associateApplicationWithStack",
|
|
3542
3638
|
"overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication",
|
|
@@ -3557,7 +3653,7 @@
|
|
|
3557
3653
|
},
|
|
3558
3654
|
"locationInModule": {
|
|
3559
3655
|
"filename": "lib/application.ts",
|
|
3560
|
-
"line":
|
|
3656
|
+
"line": 137
|
|
3561
3657
|
},
|
|
3562
3658
|
"name": "associateAttributeGroup",
|
|
3563
3659
|
"overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication",
|
|
@@ -3579,7 +3675,7 @@
|
|
|
3579
3675
|
},
|
|
3580
3676
|
"locationInModule": {
|
|
3581
3677
|
"filename": "lib/application.ts",
|
|
3582
|
-
"line":
|
|
3678
|
+
"line": 172
|
|
3583
3679
|
},
|
|
3584
3680
|
"name": "associateStack",
|
|
3585
3681
|
"overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication",
|
|
@@ -3599,7 +3695,7 @@
|
|
|
3599
3695
|
},
|
|
3600
3696
|
"locationInModule": {
|
|
3601
3697
|
"filename": "lib/application.ts",
|
|
3602
|
-
"line":
|
|
3698
|
+
"line": 334
|
|
3603
3699
|
},
|
|
3604
3700
|
"name": "generateUniqueHash",
|
|
3605
3701
|
"parameters": [
|
|
@@ -3625,7 +3721,7 @@
|
|
|
3625
3721
|
},
|
|
3626
3722
|
"locationInModule": {
|
|
3627
3723
|
"filename": "lib/application.ts",
|
|
3628
|
-
"line":
|
|
3724
|
+
"line": 210
|
|
3629
3725
|
},
|
|
3630
3726
|
"name": "shareApplication",
|
|
3631
3727
|
"overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication",
|
|
@@ -3652,7 +3748,7 @@
|
|
|
3652
3748
|
"immutable": true,
|
|
3653
3749
|
"locationInModule": {
|
|
3654
3750
|
"filename": "lib/application.ts",
|
|
3655
|
-
"line":
|
|
3751
|
+
"line": 310
|
|
3656
3752
|
},
|
|
3657
3753
|
"name": "applicationArn",
|
|
3658
3754
|
"overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication",
|
|
@@ -3668,7 +3764,7 @@
|
|
|
3668
3764
|
"immutable": true,
|
|
3669
3765
|
"locationInModule": {
|
|
3670
3766
|
"filename": "lib/application.ts",
|
|
3671
|
-
"line":
|
|
3767
|
+
"line": 311
|
|
3672
3768
|
},
|
|
3673
3769
|
"name": "applicationId",
|
|
3674
3770
|
"overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication",
|
|
@@ -3687,7 +3783,7 @@
|
|
|
3687
3783
|
"immutable": true,
|
|
3688
3784
|
"locationInModule": {
|
|
3689
3785
|
"filename": "lib/application.ts",
|
|
3690
|
-
"line":
|
|
3786
|
+
"line": 309
|
|
3691
3787
|
},
|
|
3692
3788
|
"name": "applicationManagerUrl",
|
|
3693
3789
|
"optional": true,
|
|
@@ -3703,7 +3799,7 @@
|
|
|
3703
3799
|
"immutable": true,
|
|
3704
3800
|
"locationInModule": {
|
|
3705
3801
|
"filename": "lib/application.ts",
|
|
3706
|
-
"line":
|
|
3802
|
+
"line": 312
|
|
3707
3803
|
},
|
|
3708
3804
|
"name": "applicationName",
|
|
3709
3805
|
"optional": true,
|
|
@@ -3719,10 +3815,10 @@
|
|
|
3719
3815
|
"assembly": "@aws-cdk/aws-servicecatalogappregistry-alpha",
|
|
3720
3816
|
"base": "constructs.Construct",
|
|
3721
3817
|
"docs": {
|
|
3722
|
-
"remarks": "The application name must be unique at the account level per region and it's immutable.\nThis construct will automatically associate all stacks in the given scope, however\nin case of a `Pipeline` stack, stage underneath the pipeline will not automatically be associated and\nneeds to be associated separately.\n\nIf cross account stack is detected
|
|
3818
|
+
"remarks": "The application name must be unique at the account level per region and it's immutable.\nThis construct will automatically associate all stacks in the given scope, however\nin case of a `Pipeline` stack, stage underneath the pipeline will not automatically be associated and\nneeds to be associated separately.\n\nIf cross account stack is detected and `associateCrossAccountStacks` in `TargetApplicationOptions` is `true`,\nthen the application will automatically be shared with the consumer accounts to allow associations.\nOtherwise, the application will not be shared.\nCross account feature will only work for non environment agnostic stacks.",
|
|
3723
3819
|
"stability": "experimental",
|
|
3724
3820
|
"summary": "An AppRegistry construct to automatically create an application with the given name and description.",
|
|
3725
|
-
"example": "
|
|
3821
|
+
"example": "import * as cdk from \"aws-cdk-lib\";\n\nconst app = new App();\n\nconst associatedApp = new appreg.ApplicationAssociator(app, 'AssociatedApplication', {\n applications: [appreg.TargetApplication.createApplicationStack({\n applicationName: 'MyAssociatedApplication',\n // 'Application containing stacks deployed via CDK.' is the default\n applicationDescription: 'Associated Application description',\n stackName: 'MyAssociatedApplicationStack',\n // AWS Account and Region that are implied by the current CLI configuration is the default\n env: { account: '123456789012', region: 'us-east-1' },\n })],\n});\n\n// Associate application to the attribute group.\nassociatedApp.appRegistryApplication.addAttributeGroup('MyAttributeGroup' , {\n attributeGroupName: 'MyAttributeGroupName',\n description: 'Test attribute group',\n attributes: {},\n});",
|
|
3726
3822
|
"custom": {
|
|
3727
3823
|
"exampleMetadata": "infused"
|
|
3728
3824
|
}
|
|
@@ -3734,7 +3830,7 @@
|
|
|
3734
3830
|
},
|
|
3735
3831
|
"locationInModule": {
|
|
3736
3832
|
"filename": "lib/application-associator.ts",
|
|
3737
|
-
"line":
|
|
3833
|
+
"line": 40
|
|
3738
3834
|
},
|
|
3739
3835
|
"parameters": [
|
|
3740
3836
|
{
|
|
@@ -3760,25 +3856,9 @@
|
|
|
3760
3856
|
"kind": "class",
|
|
3761
3857
|
"locationInModule": {
|
|
3762
3858
|
"filename": "lib/application-associator.ts",
|
|
3763
|
-
"line":
|
|
3859
|
+
"line": 32
|
|
3764
3860
|
},
|
|
3765
3861
|
"methods": [
|
|
3766
|
-
{
|
|
3767
|
-
"docs": {
|
|
3768
|
-
"stability": "experimental",
|
|
3769
|
-
"summary": "Get the AppRegistry application."
|
|
3770
|
-
},
|
|
3771
|
-
"locationInModule": {
|
|
3772
|
-
"filename": "lib/application-associator.ts",
|
|
3773
|
-
"line": 71
|
|
3774
|
-
},
|
|
3775
|
-
"name": "appRegistryApplication",
|
|
3776
|
-
"returns": {
|
|
3777
|
-
"type": {
|
|
3778
|
-
"fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication"
|
|
3779
|
-
}
|
|
3780
|
-
}
|
|
3781
|
-
},
|
|
3782
3862
|
{
|
|
3783
3863
|
"docs": {
|
|
3784
3864
|
"stability": "experimental",
|
|
@@ -3786,7 +3866,7 @@
|
|
|
3786
3866
|
},
|
|
3787
3867
|
"locationInModule": {
|
|
3788
3868
|
"filename": "lib/application-associator.ts",
|
|
3789
|
-
"line":
|
|
3869
|
+
"line": 60
|
|
3790
3870
|
},
|
|
3791
3871
|
"name": "associateStage",
|
|
3792
3872
|
"parameters": [
|
|
@@ -3810,7 +3890,7 @@
|
|
|
3810
3890
|
},
|
|
3811
3891
|
"locationInModule": {
|
|
3812
3892
|
"filename": "lib/application-associator.ts",
|
|
3813
|
-
"line":
|
|
3893
|
+
"line": 72
|
|
3814
3894
|
},
|
|
3815
3895
|
"name": "isStageAssociated",
|
|
3816
3896
|
"parameters": [
|
|
@@ -3829,6 +3909,23 @@
|
|
|
3829
3909
|
}
|
|
3830
3910
|
],
|
|
3831
3911
|
"name": "ApplicationAssociator",
|
|
3912
|
+
"properties": [
|
|
3913
|
+
{
|
|
3914
|
+
"docs": {
|
|
3915
|
+
"stability": "experimental",
|
|
3916
|
+
"summary": "Get the AppRegistry application."
|
|
3917
|
+
},
|
|
3918
|
+
"immutable": true,
|
|
3919
|
+
"locationInModule": {
|
|
3920
|
+
"filename": "lib/application-associator.ts",
|
|
3921
|
+
"line": 80
|
|
3922
|
+
},
|
|
3923
|
+
"name": "appRegistryApplication",
|
|
3924
|
+
"type": {
|
|
3925
|
+
"fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication"
|
|
3926
|
+
}
|
|
3927
|
+
}
|
|
3928
|
+
],
|
|
3832
3929
|
"symbolId": "lib/application-associator:ApplicationAssociator"
|
|
3833
3930
|
},
|
|
3834
3931
|
"@aws-cdk/aws-servicecatalogappregistry-alpha.ApplicationAssociatorProps": {
|
|
@@ -3837,7 +3934,7 @@
|
|
|
3837
3934
|
"docs": {
|
|
3838
3935
|
"stability": "experimental",
|
|
3839
3936
|
"summary": "Properties for Service Catalog AppRegistry Application Associator.",
|
|
3840
|
-
"example": "
|
|
3937
|
+
"example": "import * as cdk from \"aws-cdk-lib\";\n\nconst app = new App();\n\nconst associatedApp = new appreg.ApplicationAssociator(app, 'AssociatedApplication', {\n applications: [appreg.TargetApplication.createApplicationStack({\n applicationName: 'MyAssociatedApplication',\n // 'Application containing stacks deployed via CDK.' is the default\n applicationDescription: 'Associated Application description',\n stackName: 'MyAssociatedApplicationStack',\n // AWS Account and Region that are implied by the current CLI configuration is the default\n env: { account: '123456789012', region: 'us-east-1' },\n })],\n});\n\n// Associate application to the attribute group.\nassociatedApp.appRegistryApplication.addAttributeGroup('MyAttributeGroup' , {\n attributeGroupName: 'MyAttributeGroupName',\n description: 'Test attribute group',\n attributes: {},\n});",
|
|
3841
3938
|
"custom": {
|
|
3842
3939
|
"exampleMetadata": "infused"
|
|
3843
3940
|
}
|
|
@@ -3890,7 +3987,7 @@
|
|
|
3890
3987
|
"kind": "interface",
|
|
3891
3988
|
"locationInModule": {
|
|
3892
3989
|
"filename": "lib/application.ts",
|
|
3893
|
-
"line":
|
|
3990
|
+
"line": 111
|
|
3894
3991
|
},
|
|
3895
3992
|
"name": "ApplicationProps",
|
|
3896
3993
|
"properties": [
|
|
@@ -3903,7 +4000,7 @@
|
|
|
3903
4000
|
"immutable": true,
|
|
3904
4001
|
"locationInModule": {
|
|
3905
4002
|
"filename": "lib/application.ts",
|
|
3906
|
-
"line":
|
|
4003
|
+
"line": 115
|
|
3907
4004
|
},
|
|
3908
4005
|
"name": "applicationName",
|
|
3909
4006
|
"type": {
|
|
@@ -3920,7 +4017,7 @@
|
|
|
3920
4017
|
"immutable": true,
|
|
3921
4018
|
"locationInModule": {
|
|
3922
4019
|
"filename": "lib/application.ts",
|
|
3923
|
-
"line":
|
|
4020
|
+
"line": 121
|
|
3924
4021
|
},
|
|
3925
4022
|
"name": "description",
|
|
3926
4023
|
"optional": true,
|
|
@@ -4154,13 +4251,91 @@
|
|
|
4154
4251
|
],
|
|
4155
4252
|
"symbolId": "lib/attribute-group:AttributeGroup"
|
|
4156
4253
|
},
|
|
4254
|
+
"@aws-cdk/aws-servicecatalogappregistry-alpha.AttributeGroupAssociationProps": {
|
|
4255
|
+
"assembly": "@aws-cdk/aws-servicecatalogappregistry-alpha",
|
|
4256
|
+
"datatype": true,
|
|
4257
|
+
"docs": {
|
|
4258
|
+
"stability": "experimental",
|
|
4259
|
+
"summary": "Properties for a Service Catalog AppRegistry Attribute Group.",
|
|
4260
|
+
"example": "import * as cdk from \"aws-cdk-lib\";\n\nconst app = new App();\n\nconst associatedApp = new appreg.ApplicationAssociator(app, 'AssociatedApplication', {\n applications: [appreg.TargetApplication.createApplicationStack({\n applicationName: 'MyAssociatedApplication',\n // 'Application containing stacks deployed via CDK.' is the default\n applicationDescription: 'Associated Application description',\n stackName: 'MyAssociatedApplicationStack',\n // AWS Account and Region that are implied by the current CLI configuration is the default\n env: { account: '123456789012', region: 'us-east-1' },\n })],\n});\n\n// Associate application to the attribute group.\nassociatedApp.appRegistryApplication.addAttributeGroup('MyAttributeGroup' , {\n attributeGroupName: 'MyAttributeGroupName',\n description: 'Test attribute group',\n attributes: {},\n});",
|
|
4261
|
+
"custom": {
|
|
4262
|
+
"exampleMetadata": "infused"
|
|
4263
|
+
}
|
|
4264
|
+
},
|
|
4265
|
+
"fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.AttributeGroupAssociationProps",
|
|
4266
|
+
"kind": "interface",
|
|
4267
|
+
"locationInModule": {
|
|
4268
|
+
"filename": "lib/application.ts",
|
|
4269
|
+
"line": 18
|
|
4270
|
+
},
|
|
4271
|
+
"name": "AttributeGroupAssociationProps",
|
|
4272
|
+
"properties": [
|
|
4273
|
+
{
|
|
4274
|
+
"abstract": true,
|
|
4275
|
+
"docs": {
|
|
4276
|
+
"stability": "experimental",
|
|
4277
|
+
"summary": "Name for attribute group."
|
|
4278
|
+
},
|
|
4279
|
+
"immutable": true,
|
|
4280
|
+
"locationInModule": {
|
|
4281
|
+
"filename": "lib/application.ts",
|
|
4282
|
+
"line": 23
|
|
4283
|
+
},
|
|
4284
|
+
"name": "attributeGroupName",
|
|
4285
|
+
"type": {
|
|
4286
|
+
"primitive": "string"
|
|
4287
|
+
}
|
|
4288
|
+
},
|
|
4289
|
+
{
|
|
4290
|
+
"abstract": true,
|
|
4291
|
+
"docs": {
|
|
4292
|
+
"remarks": "Attributes maybe an empty JSON '{}', but must be explicitly stated.",
|
|
4293
|
+
"stability": "experimental",
|
|
4294
|
+
"summary": "A JSON of nested key-value pairs that represent the attributes in the group."
|
|
4295
|
+
},
|
|
4296
|
+
"immutable": true,
|
|
4297
|
+
"locationInModule": {
|
|
4298
|
+
"filename": "lib/application.ts",
|
|
4299
|
+
"line": 35
|
|
4300
|
+
},
|
|
4301
|
+
"name": "attributes",
|
|
4302
|
+
"type": {
|
|
4303
|
+
"collection": {
|
|
4304
|
+
"elementtype": {
|
|
4305
|
+
"primitive": "any"
|
|
4306
|
+
},
|
|
4307
|
+
"kind": "map"
|
|
4308
|
+
}
|
|
4309
|
+
}
|
|
4310
|
+
},
|
|
4311
|
+
{
|
|
4312
|
+
"abstract": true,
|
|
4313
|
+
"docs": {
|
|
4314
|
+
"default": "- No description provided",
|
|
4315
|
+
"stability": "experimental",
|
|
4316
|
+
"summary": "Description for attribute group."
|
|
4317
|
+
},
|
|
4318
|
+
"immutable": true,
|
|
4319
|
+
"locationInModule": {
|
|
4320
|
+
"filename": "lib/application.ts",
|
|
4321
|
+
"line": 29
|
|
4322
|
+
},
|
|
4323
|
+
"name": "description",
|
|
4324
|
+
"optional": true,
|
|
4325
|
+
"type": {
|
|
4326
|
+
"primitive": "string"
|
|
4327
|
+
}
|
|
4328
|
+
}
|
|
4329
|
+
],
|
|
4330
|
+
"symbolId": "lib/application:AttributeGroupAssociationProps"
|
|
4331
|
+
},
|
|
4157
4332
|
"@aws-cdk/aws-servicecatalogappregistry-alpha.AttributeGroupProps": {
|
|
4158
4333
|
"assembly": "@aws-cdk/aws-servicecatalogappregistry-alpha",
|
|
4159
4334
|
"datatype": true,
|
|
4160
4335
|
"docs": {
|
|
4161
4336
|
"stability": "experimental",
|
|
4162
4337
|
"summary": "Properties for a Service Catalog AppRegistry Attribute Group.",
|
|
4163
|
-
"example": "
|
|
4338
|
+
"example": "const attributeGroup = new appreg.AttributeGroup(this, 'MyFirstAttributeGroup', {\n attributeGroupName: '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});",
|
|
4164
4339
|
"custom": {
|
|
4165
4340
|
"exampleMetadata": "infused"
|
|
4166
4341
|
}
|
|
@@ -4238,7 +4413,7 @@
|
|
|
4238
4413
|
"docs": {
|
|
4239
4414
|
"stability": "experimental",
|
|
4240
4415
|
"summary": "Properties for Service Catalog AppRegistry Application Associator to work with.",
|
|
4241
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as servicecatalogappregistry_alpha from '@aws-cdk/aws-servicecatalogappregistry-alpha';\n\ndeclare const application: servicecatalogappregistry_alpha.Application;\nconst bindTargetApplicationResult: servicecatalogappregistry_alpha.BindTargetApplicationResult = {\n application: application,\n};",
|
|
4416
|
+
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as servicecatalogappregistry_alpha from '@aws-cdk/aws-servicecatalogappregistry-alpha';\n\ndeclare const application: servicecatalogappregistry_alpha.Application;\nconst bindTargetApplicationResult: servicecatalogappregistry_alpha.BindTargetApplicationResult = {\n application: application,\n associateCrossAccountStacks: false,\n};",
|
|
4242
4417
|
"custom": {
|
|
4243
4418
|
"exampleMetadata": "fixture=_generated"
|
|
4244
4419
|
}
|
|
@@ -4247,7 +4422,7 @@
|
|
|
4247
4422
|
"kind": "interface",
|
|
4248
4423
|
"locationInModule": {
|
|
4249
4424
|
"filename": "lib/target-application.ts",
|
|
4250
|
-
"line":
|
|
4425
|
+
"line": 93
|
|
4251
4426
|
},
|
|
4252
4427
|
"name": "BindTargetApplicationResult",
|
|
4253
4428
|
"properties": [
|
|
@@ -4260,12 +4435,28 @@
|
|
|
4260
4435
|
"immutable": true,
|
|
4261
4436
|
"locationInModule": {
|
|
4262
4437
|
"filename": "lib/target-application.ts",
|
|
4263
|
-
"line":
|
|
4438
|
+
"line": 97
|
|
4264
4439
|
},
|
|
4265
4440
|
"name": "application",
|
|
4266
4441
|
"type": {
|
|
4267
4442
|
"fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication"
|
|
4268
4443
|
}
|
|
4444
|
+
},
|
|
4445
|
+
{
|
|
4446
|
+
"abstract": true,
|
|
4447
|
+
"docs": {
|
|
4448
|
+
"stability": "experimental",
|
|
4449
|
+
"summary": "Enables cross-account associations with the target application."
|
|
4450
|
+
},
|
|
4451
|
+
"immutable": true,
|
|
4452
|
+
"locationInModule": {
|
|
4453
|
+
"filename": "lib/target-application.ts",
|
|
4454
|
+
"line": 101
|
|
4455
|
+
},
|
|
4456
|
+
"name": "associateCrossAccountStacks",
|
|
4457
|
+
"type": {
|
|
4458
|
+
"primitive": "boolean"
|
|
4459
|
+
}
|
|
4269
4460
|
}
|
|
4270
4461
|
],
|
|
4271
4462
|
"symbolId": "lib/target-application:BindTargetApplicationResult"
|
|
@@ -4276,7 +4467,7 @@
|
|
|
4276
4467
|
"docs": {
|
|
4277
4468
|
"stability": "experimental",
|
|
4278
4469
|
"summary": "Properties used to define New TargetApplication.",
|
|
4279
|
-
"example": "import * as cdk from \"aws-cdk-lib\";\n\nconst app = new App();\n\
|
|
4470
|
+
"example": "import * as cdk from \"aws-cdk-lib\";\n\nconst app = new App();\n\nconst associatedApp = new appreg.ApplicationAssociator(app, 'AssociatedApplication', {\n applications: [appreg.TargetApplication.createApplicationStack({\n applicationName: 'MyAssociatedApplication',\n // 'Application containing stacks deployed via CDK.' is the default\n applicationDescription: 'Associated Application description',\n stackName: 'MyAssociatedApplicationStack',\n // AWS Account and Region that are implied by the current CLI configuration is the default\n env: { account: '123456789012', region: 'us-east-1' },\n })],\n});\n\n// Associate application to the attribute group.\nassociatedApp.appRegistryApplication.addAttributeGroup('MyAttributeGroup' , {\n attributeGroupName: 'MyAttributeGroupName',\n description: 'Test attribute group',\n attributes: {},\n});",
|
|
4280
4471
|
"custom": {
|
|
4281
4472
|
"exampleMetadata": "infused"
|
|
4282
4473
|
}
|
|
@@ -4288,7 +4479,7 @@
|
|
|
4288
4479
|
"kind": "interface",
|
|
4289
4480
|
"locationInModule": {
|
|
4290
4481
|
"filename": "lib/target-application.ts",
|
|
4291
|
-
"line":
|
|
4482
|
+
"line": 32
|
|
4292
4483
|
},
|
|
4293
4484
|
"name": "CreateTargetApplicationOptions",
|
|
4294
4485
|
"properties": [
|
|
@@ -4301,7 +4492,7 @@
|
|
|
4301
4492
|
"immutable": true,
|
|
4302
4493
|
"locationInModule": {
|
|
4303
4494
|
"filename": "lib/target-application.ts",
|
|
4304
|
-
"line":
|
|
4495
|
+
"line": 36
|
|
4305
4496
|
},
|
|
4306
4497
|
"name": "applicationName",
|
|
4307
4498
|
"type": {
|
|
@@ -4318,7 +4509,7 @@
|
|
|
4318
4509
|
"immutable": true,
|
|
4319
4510
|
"locationInModule": {
|
|
4320
4511
|
"filename": "lib/target-application.ts",
|
|
4321
|
-
"line":
|
|
4512
|
+
"line": 43
|
|
4322
4513
|
},
|
|
4323
4514
|
"name": "applicationDescription",
|
|
4324
4515
|
"optional": true,
|
|
@@ -4329,14 +4520,14 @@
|
|
|
4329
4520
|
{
|
|
4330
4521
|
"abstract": true,
|
|
4331
4522
|
"docs": {
|
|
4332
|
-
"default": "-
|
|
4523
|
+
"default": "- true",
|
|
4333
4524
|
"stability": "experimental",
|
|
4334
4525
|
"summary": "Whether create cloudFormation Output for application manager URL."
|
|
4335
4526
|
},
|
|
4336
4527
|
"immutable": true,
|
|
4337
4528
|
"locationInModule": {
|
|
4338
4529
|
"filename": "lib/target-application.ts",
|
|
4339
|
-
"line":
|
|
4530
|
+
"line": 50
|
|
4340
4531
|
},
|
|
4341
4532
|
"name": "emitApplicationManagerUrlAsOutput",
|
|
4342
4533
|
"optional": true,
|
|
@@ -4365,7 +4556,7 @@
|
|
|
4365
4556
|
"kind": "interface",
|
|
4366
4557
|
"locationInModule": {
|
|
4367
4558
|
"filename": "lib/target-application.ts",
|
|
4368
|
-
"line":
|
|
4559
|
+
"line": 56
|
|
4369
4560
|
},
|
|
4370
4561
|
"name": "ExistingTargetApplicationOptions",
|
|
4371
4562
|
"properties": [
|
|
@@ -4378,7 +4569,7 @@
|
|
|
4378
4569
|
"immutable": true,
|
|
4379
4570
|
"locationInModule": {
|
|
4380
4571
|
"filename": "lib/target-application.ts",
|
|
4381
|
-
"line":
|
|
4572
|
+
"line": 60
|
|
4382
4573
|
},
|
|
4383
4574
|
"name": "applicationArnValue",
|
|
4384
4575
|
"type": {
|
|
@@ -4401,9 +4592,46 @@
|
|
|
4401
4592
|
"kind": "interface",
|
|
4402
4593
|
"locationInModule": {
|
|
4403
4594
|
"filename": "lib/application.ts",
|
|
4404
|
-
"line":
|
|
4595
|
+
"line": 41
|
|
4405
4596
|
},
|
|
4406
4597
|
"methods": [
|
|
4598
|
+
{
|
|
4599
|
+
"abstract": true,
|
|
4600
|
+
"docs": {
|
|
4601
|
+
"stability": "experimental",
|
|
4602
|
+
"summary": "Create an attribute group and associate this application with the created attribute group."
|
|
4603
|
+
},
|
|
4604
|
+
"locationInModule": {
|
|
4605
|
+
"filename": "lib/application.ts",
|
|
4606
|
+
"line": 73
|
|
4607
|
+
},
|
|
4608
|
+
"name": "addAttributeGroup",
|
|
4609
|
+
"parameters": [
|
|
4610
|
+
{
|
|
4611
|
+
"docs": {
|
|
4612
|
+
"summary": "name of the AttributeGroup construct to be created."
|
|
4613
|
+
},
|
|
4614
|
+
"name": "id",
|
|
4615
|
+
"type": {
|
|
4616
|
+
"primitive": "string"
|
|
4617
|
+
}
|
|
4618
|
+
},
|
|
4619
|
+
{
|
|
4620
|
+
"docs": {
|
|
4621
|
+
"summary": "AppRegistry attribute group props."
|
|
4622
|
+
},
|
|
4623
|
+
"name": "attributeGroupProps",
|
|
4624
|
+
"type": {
|
|
4625
|
+
"fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.AttributeGroupAssociationProps"
|
|
4626
|
+
}
|
|
4627
|
+
}
|
|
4628
|
+
],
|
|
4629
|
+
"returns": {
|
|
4630
|
+
"type": {
|
|
4631
|
+
"fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.IAttributeGroup"
|
|
4632
|
+
}
|
|
4633
|
+
}
|
|
4634
|
+
},
|
|
4407
4635
|
{
|
|
4408
4636
|
"abstract": true,
|
|
4409
4637
|
"docs": {
|
|
@@ -4413,7 +4641,7 @@
|
|
|
4413
4641
|
},
|
|
4414
4642
|
"locationInModule": {
|
|
4415
4643
|
"filename": "lib/application.ts",
|
|
4416
|
-
"line":
|
|
4644
|
+
"line": 104
|
|
4417
4645
|
},
|
|
4418
4646
|
"name": "associateAllStacksInScope",
|
|
4419
4647
|
"parameters": [
|
|
@@ -4436,7 +4664,7 @@
|
|
|
4436
4664
|
},
|
|
4437
4665
|
"locationInModule": {
|
|
4438
4666
|
"filename": "lib/application.ts",
|
|
4439
|
-
"line":
|
|
4667
|
+
"line": 88
|
|
4440
4668
|
},
|
|
4441
4669
|
"name": "associateApplicationWithStack",
|
|
4442
4670
|
"parameters": [
|
|
@@ -4459,7 +4687,7 @@
|
|
|
4459
4687
|
},
|
|
4460
4688
|
"locationInModule": {
|
|
4461
4689
|
"filename": "lib/application.ts",
|
|
4462
|
-
"line":
|
|
4690
|
+
"line": 65
|
|
4463
4691
|
},
|
|
4464
4692
|
"name": "associateAttributeGroup",
|
|
4465
4693
|
"parameters": [
|
|
@@ -4483,7 +4711,7 @@
|
|
|
4483
4711
|
},
|
|
4484
4712
|
"locationInModule": {
|
|
4485
4713
|
"filename": "lib/application.ts",
|
|
4486
|
-
"line":
|
|
4714
|
+
"line": 81
|
|
4487
4715
|
},
|
|
4488
4716
|
"name": "associateStack",
|
|
4489
4717
|
"parameters": [
|
|
@@ -4506,7 +4734,7 @@
|
|
|
4506
4734
|
},
|
|
4507
4735
|
"locationInModule": {
|
|
4508
4736
|
"filename": "lib/application.ts",
|
|
4509
|
-
"line":
|
|
4737
|
+
"line": 95
|
|
4510
4738
|
},
|
|
4511
4739
|
"name": "shareApplication",
|
|
4512
4740
|
"parameters": [
|
|
@@ -4536,7 +4764,7 @@
|
|
|
4536
4764
|
"immutable": true,
|
|
4537
4765
|
"locationInModule": {
|
|
4538
4766
|
"filename": "lib/application.ts",
|
|
4539
|
-
"line":
|
|
4767
|
+
"line": 46
|
|
4540
4768
|
},
|
|
4541
4769
|
"name": "applicationArn",
|
|
4542
4770
|
"type": {
|
|
@@ -4555,7 +4783,7 @@
|
|
|
4555
4783
|
"immutable": true,
|
|
4556
4784
|
"locationInModule": {
|
|
4557
4785
|
"filename": "lib/application.ts",
|
|
4558
|
-
"line":
|
|
4786
|
+
"line": 52
|
|
4559
4787
|
},
|
|
4560
4788
|
"name": "applicationId",
|
|
4561
4789
|
"type": {
|
|
@@ -4574,7 +4802,7 @@
|
|
|
4574
4802
|
"immutable": true,
|
|
4575
4803
|
"locationInModule": {
|
|
4576
4804
|
"filename": "lib/application.ts",
|
|
4577
|
-
"line":
|
|
4805
|
+
"line": 58
|
|
4578
4806
|
},
|
|
4579
4807
|
"name": "applicationName",
|
|
4580
4808
|
"optional": true,
|
|
@@ -4850,7 +5078,7 @@
|
|
|
4850
5078
|
"docs": {
|
|
4851
5079
|
"stability": "experimental",
|
|
4852
5080
|
"summary": "Contains static factory methods with which you can build the input needed for application associator to work.",
|
|
4853
|
-
"example": "
|
|
5081
|
+
"example": "import * as cdk from \"aws-cdk-lib\";\n\nconst app = new App();\n\nconst associatedApp = new appreg.ApplicationAssociator(app, 'AssociatedApplication', {\n applications: [appreg.TargetApplication.createApplicationStack({\n applicationName: 'MyAssociatedApplication',\n // 'Application containing stacks deployed via CDK.' is the default\n applicationDescription: 'Associated Application description',\n stackName: 'MyAssociatedApplicationStack',\n // AWS Account and Region that are implied by the current CLI configuration is the default\n env: { account: '123456789012', region: 'us-east-1' },\n })],\n});\n\n// Associate application to the attribute group.\nassociatedApp.appRegistryApplication.addAttributeGroup('MyAttributeGroup' , {\n attributeGroupName: 'MyAttributeGroupName',\n description: 'Test attribute group',\n attributes: {},\n});",
|
|
4854
5082
|
"custom": {
|
|
4855
5083
|
"exampleMetadata": "infused"
|
|
4856
5084
|
}
|
|
@@ -4864,7 +5092,7 @@
|
|
|
4864
5092
|
"kind": "class",
|
|
4865
5093
|
"locationInModule": {
|
|
4866
5094
|
"filename": "lib/target-application.ts",
|
|
4867
|
-
"line":
|
|
5095
|
+
"line": 67
|
|
4868
5096
|
},
|
|
4869
5097
|
"methods": [
|
|
4870
5098
|
{
|
|
@@ -4874,7 +5102,7 @@
|
|
|
4874
5102
|
},
|
|
4875
5103
|
"locationInModule": {
|
|
4876
5104
|
"filename": "lib/target-application.ts",
|
|
4877
|
-
"line":
|
|
5105
|
+
"line": 80
|
|
4878
5106
|
},
|
|
4879
5107
|
"name": "createApplicationStack",
|
|
4880
5108
|
"parameters": [
|
|
@@ -4899,7 +5127,7 @@
|
|
|
4899
5127
|
},
|
|
4900
5128
|
"locationInModule": {
|
|
4901
5129
|
"filename": "lib/target-application.ts",
|
|
4902
|
-
"line":
|
|
5130
|
+
"line": 72
|
|
4903
5131
|
},
|
|
4904
5132
|
"name": "existingApplicationFromArn",
|
|
4905
5133
|
"parameters": [
|
|
@@ -4925,7 +5153,7 @@
|
|
|
4925
5153
|
},
|
|
4926
5154
|
"locationInModule": {
|
|
4927
5155
|
"filename": "lib/target-application.ts",
|
|
4928
|
-
"line":
|
|
5156
|
+
"line": 87
|
|
4929
5157
|
},
|
|
4930
5158
|
"name": "bind",
|
|
4931
5159
|
"parameters": [
|
|
@@ -4952,7 +5180,7 @@
|
|
|
4952
5180
|
"docs": {
|
|
4953
5181
|
"stability": "experimental",
|
|
4954
5182
|
"summary": "Properties used to define targetapplication.",
|
|
4955
|
-
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as servicecatalogappregistry_alpha from '@aws-cdk/aws-servicecatalogappregistry-alpha';\nimport * as cdk from 'aws-cdk-lib';\n\ndeclare const permissionsBoundary: cdk.PermissionsBoundary;\ndeclare const stackSynthesizer: cdk.StackSynthesizer;\nconst targetApplicationCommonOptions: servicecatalogappregistry_alpha.TargetApplicationCommonOptions = {\n analyticsReporting: false,\n crossRegionReferences: false,\n description: 'description',\n env: {\n account: 'account',\n region: 'region',\n },\n permissionsBoundary: permissionsBoundary,\n stackId: 'stackId',\n stackName: 'stackName',\n synthesizer: stackSynthesizer,\n tags: {\n tagsKey: 'tags',\n },\n terminationProtection: false,\n};",
|
|
5183
|
+
"example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as servicecatalogappregistry_alpha from '@aws-cdk/aws-servicecatalogappregistry-alpha';\nimport * as cdk from 'aws-cdk-lib';\n\ndeclare const permissionsBoundary: cdk.PermissionsBoundary;\ndeclare const stackSynthesizer: cdk.StackSynthesizer;\nconst targetApplicationCommonOptions: servicecatalogappregistry_alpha.TargetApplicationCommonOptions = {\n analyticsReporting: false,\n associateCrossAccountStacks: false,\n crossRegionReferences: false,\n description: 'description',\n env: {\n account: 'account',\n region: 'region',\n },\n permissionsBoundary: permissionsBoundary,\n stackId: 'stackId',\n stackName: 'stackName',\n synthesizer: stackSynthesizer,\n tags: {\n tagsKey: 'tags',\n },\n terminationProtection: false,\n};",
|
|
4956
5184
|
"custom": {
|
|
4957
5185
|
"exampleMetadata": "fixture=_generated"
|
|
4958
5186
|
}
|
|
@@ -4968,6 +5196,25 @@
|
|
|
4968
5196
|
},
|
|
4969
5197
|
"name": "TargetApplicationCommonOptions",
|
|
4970
5198
|
"properties": [
|
|
5199
|
+
{
|
|
5200
|
+
"abstract": true,
|
|
5201
|
+
"docs": {
|
|
5202
|
+
"default": "- false",
|
|
5203
|
+
"remarks": "If set to `true`, the application will first be shared with the accounts that own the stacks.",
|
|
5204
|
+
"stability": "experimental",
|
|
5205
|
+
"summary": "Determines whether any cross-account stacks defined in the CDK app definition should be associated with the target application."
|
|
5206
|
+
},
|
|
5207
|
+
"immutable": true,
|
|
5208
|
+
"locationInModule": {
|
|
5209
|
+
"filename": "lib/target-application.ts",
|
|
5210
|
+
"line": 25
|
|
5211
|
+
},
|
|
5212
|
+
"name": "associateCrossAccountStacks",
|
|
5213
|
+
"optional": true,
|
|
5214
|
+
"type": {
|
|
5215
|
+
"primitive": "boolean"
|
|
5216
|
+
}
|
|
5217
|
+
},
|
|
4971
5218
|
{
|
|
4972
5219
|
"abstract": true,
|
|
4973
5220
|
"docs": {
|
|
@@ -4992,6 +5239,6 @@
|
|
|
4992
5239
|
"symbolId": "lib/target-application:TargetApplicationCommonOptions"
|
|
4993
5240
|
}
|
|
4994
5241
|
},
|
|
4995
|
-
"version": "2.
|
|
5242
|
+
"version": "2.71.0-alpha.0",
|
|
4996
5243
|
"fingerprint": "**********"
|
|
4997
5244
|
}
|