@aws-cdk/aws-servicecatalogappregistry-alpha 2.38.1-alpha.0 → 2.40.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 +341 -48
- package/.jsii.tabl.json +382 -18
- package/.warnings.jsii.js +17 -1
- package/README.md +59 -0
- package/lib/application.d.ts +20 -0
- package/lib/application.js +39 -13
- package/lib/attribute-group.d.ts +12 -0
- package/lib/attribute-group.js +31 -2
- package/lib/common.d.ts +60 -0
- package/lib/common.js +48 -0
- package/lib/index.d.ts +1 -0
- package/lib/index.js +2 -1
- package/package.json +7 -7
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.40.0",
|
|
12
12
|
"constructs": "^10.0.0"
|
|
13
13
|
},
|
|
14
14
|
"dependencyClosure": {
|
|
@@ -3024,7 +3024,7 @@
|
|
|
3024
3024
|
"stability": "experimental"
|
|
3025
3025
|
},
|
|
3026
3026
|
"homepage": "https://github.com/aws/aws-cdk",
|
|
3027
|
-
"jsiiVersion": "1.
|
|
3027
|
+
"jsiiVersion": "1.66.0 (build 3c9512b)",
|
|
3028
3028
|
"keywords": [
|
|
3029
3029
|
"aws",
|
|
3030
3030
|
"cdk",
|
|
@@ -3046,7 +3046,7 @@
|
|
|
3046
3046
|
},
|
|
3047
3047
|
"name": "@aws-cdk/aws-servicecatalogappregistry-alpha",
|
|
3048
3048
|
"readme": {
|
|
3049
|
-
"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 repositores of applications and associated resources.\n\n## Table Of Contents\n\n- [Application](#application)\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\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, but is mutable.\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## 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```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 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"
|
|
3049
|
+
"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 repositores of applications and associated resources.\n\n## Table Of Contents\n\n- [Application](#application)\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, but is mutable.\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## 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```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 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"
|
|
3050
3050
|
},
|
|
3051
3051
|
"repository": {
|
|
3052
3052
|
"directory": "packages/individual-packages/aws-servicecatalogappregistry",
|
|
@@ -3090,12 +3090,12 @@
|
|
|
3090
3090
|
"assembly": "@aws-cdk/aws-servicecatalogappregistry-alpha",
|
|
3091
3091
|
"base": "aws-cdk-lib.Resource",
|
|
3092
3092
|
"docs": {
|
|
3093
|
+
"stability": "experimental",
|
|
3094
|
+
"summary": "A Service Catalog AppRegistry Application.",
|
|
3095
|
+
"example": "const application = new appreg.Application(this, 'MyFirstApplication', {\n applicationName: 'MyFirstApplicationName',\n description: 'description for my application', // the description is optional\n});",
|
|
3093
3096
|
"custom": {
|
|
3094
3097
|
"exampleMetadata": "infused"
|
|
3095
|
-
}
|
|
3096
|
-
"example": "const application = new appreg.Application(this, 'MyFirstApplication', {\n applicationName: 'MyFirstApplicationName',\n description: 'description for my application', // the description is optional\n});",
|
|
3097
|
-
"stability": "experimental",
|
|
3098
|
-
"summary": "A Service Catalog AppRegistry Application."
|
|
3098
|
+
}
|
|
3099
3099
|
},
|
|
3100
3100
|
"fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.Application",
|
|
3101
3101
|
"initializer": {
|
|
@@ -3104,7 +3104,7 @@
|
|
|
3104
3104
|
},
|
|
3105
3105
|
"locationInModule": {
|
|
3106
3106
|
"filename": "lib/application.ts",
|
|
3107
|
-
"line":
|
|
3107
|
+
"line": 181
|
|
3108
3108
|
},
|
|
3109
3109
|
"parameters": [
|
|
3110
3110
|
{
|
|
@@ -3133,7 +3133,7 @@
|
|
|
3133
3133
|
"kind": "class",
|
|
3134
3134
|
"locationInModule": {
|
|
3135
3135
|
"filename": "lib/application.ts",
|
|
3136
|
-
"line":
|
|
3136
|
+
"line": 147
|
|
3137
3137
|
},
|
|
3138
3138
|
"methods": [
|
|
3139
3139
|
{
|
|
@@ -3143,7 +3143,7 @@
|
|
|
3143
3143
|
},
|
|
3144
3144
|
"locationInModule": {
|
|
3145
3145
|
"filename": "lib/application.ts",
|
|
3146
|
-
"line":
|
|
3146
|
+
"line": 155
|
|
3147
3147
|
},
|
|
3148
3148
|
"name": "fromApplicationArn",
|
|
3149
3149
|
"parameters": [
|
|
@@ -3189,7 +3189,7 @@
|
|
|
3189
3189
|
},
|
|
3190
3190
|
"locationInModule": {
|
|
3191
3191
|
"filename": "lib/application.ts",
|
|
3192
|
-
"line":
|
|
3192
|
+
"line": 77
|
|
3193
3193
|
},
|
|
3194
3194
|
"name": "associateAttributeGroup",
|
|
3195
3195
|
"overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication",
|
|
@@ -3210,7 +3210,7 @@
|
|
|
3210
3210
|
},
|
|
3211
3211
|
"locationInModule": {
|
|
3212
3212
|
"filename": "lib/application.ts",
|
|
3213
|
-
"line":
|
|
3213
|
+
"line": 93
|
|
3214
3214
|
},
|
|
3215
3215
|
"name": "associateStack",
|
|
3216
3216
|
"overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication",
|
|
@@ -3230,7 +3230,7 @@
|
|
|
3230
3230
|
},
|
|
3231
3231
|
"locationInModule": {
|
|
3232
3232
|
"filename": "lib/application.ts",
|
|
3233
|
-
"line":
|
|
3233
|
+
"line": 196
|
|
3234
3234
|
},
|
|
3235
3235
|
"name": "generateUniqueHash",
|
|
3236
3236
|
"parameters": [
|
|
@@ -3247,6 +3247,30 @@
|
|
|
3247
3247
|
"primitive": "string"
|
|
3248
3248
|
}
|
|
3249
3249
|
}
|
|
3250
|
+
},
|
|
3251
|
+
{
|
|
3252
|
+
"docs": {
|
|
3253
|
+
"remarks": "The application will become available to end users within those principals.",
|
|
3254
|
+
"stability": "experimental",
|
|
3255
|
+
"summary": "Share an application with accounts, organizations and OUs, and IAM roles and users."
|
|
3256
|
+
},
|
|
3257
|
+
"locationInModule": {
|
|
3258
|
+
"filename": "lib/application.ts",
|
|
3259
|
+
"line": 111
|
|
3260
|
+
},
|
|
3261
|
+
"name": "shareApplication",
|
|
3262
|
+
"overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication",
|
|
3263
|
+
"parameters": [
|
|
3264
|
+
{
|
|
3265
|
+
"docs": {
|
|
3266
|
+
"summary": "The options for the share."
|
|
3267
|
+
},
|
|
3268
|
+
"name": "shareOptions",
|
|
3269
|
+
"type": {
|
|
3270
|
+
"fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.ShareOptions"
|
|
3271
|
+
}
|
|
3272
|
+
}
|
|
3273
|
+
]
|
|
3250
3274
|
}
|
|
3251
3275
|
],
|
|
3252
3276
|
"name": "Application",
|
|
@@ -3259,7 +3283,7 @@
|
|
|
3259
3283
|
"immutable": true,
|
|
3260
3284
|
"locationInModule": {
|
|
3261
3285
|
"filename": "lib/application.ts",
|
|
3262
|
-
"line":
|
|
3286
|
+
"line": 177
|
|
3263
3287
|
},
|
|
3264
3288
|
"name": "applicationArn",
|
|
3265
3289
|
"overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication",
|
|
@@ -3275,7 +3299,7 @@
|
|
|
3275
3299
|
"immutable": true,
|
|
3276
3300
|
"locationInModule": {
|
|
3277
3301
|
"filename": "lib/application.ts",
|
|
3278
|
-
"line":
|
|
3302
|
+
"line": 178
|
|
3279
3303
|
},
|
|
3280
3304
|
"name": "applicationId",
|
|
3281
3305
|
"overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication",
|
|
@@ -3290,18 +3314,18 @@
|
|
|
3290
3314
|
"assembly": "@aws-cdk/aws-servicecatalogappregistry-alpha",
|
|
3291
3315
|
"datatype": true,
|
|
3292
3316
|
"docs": {
|
|
3317
|
+
"stability": "experimental",
|
|
3318
|
+
"summary": "Properties for a Service Catalog AppRegistry Application.",
|
|
3319
|
+
"example": "const application = new appreg.Application(this, 'MyFirstApplication', {\n applicationName: 'MyFirstApplicationName',\n description: 'description for my application', // the description is optional\n});",
|
|
3293
3320
|
"custom": {
|
|
3294
3321
|
"exampleMetadata": "infused"
|
|
3295
|
-
}
|
|
3296
|
-
"example": "const application = new appreg.Application(this, 'MyFirstApplication', {\n applicationName: 'MyFirstApplicationName',\n description: 'description for my application', // the description is optional\n});",
|
|
3297
|
-
"stability": "experimental",
|
|
3298
|
-
"summary": "Properties for a Service Catalog AppRegistry Application."
|
|
3322
|
+
}
|
|
3299
3323
|
},
|
|
3300
3324
|
"fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.ApplicationProps",
|
|
3301
3325
|
"kind": "interface",
|
|
3302
3326
|
"locationInModule": {
|
|
3303
3327
|
"filename": "lib/application.ts",
|
|
3304
|
-
"line":
|
|
3328
|
+
"line": 54
|
|
3305
3329
|
},
|
|
3306
3330
|
"name": "ApplicationProps",
|
|
3307
3331
|
"properties": [
|
|
@@ -3314,7 +3338,7 @@
|
|
|
3314
3338
|
"immutable": true,
|
|
3315
3339
|
"locationInModule": {
|
|
3316
3340
|
"filename": "lib/application.ts",
|
|
3317
|
-
"line":
|
|
3341
|
+
"line": 58
|
|
3318
3342
|
},
|
|
3319
3343
|
"name": "applicationName",
|
|
3320
3344
|
"type": {
|
|
@@ -3331,7 +3355,7 @@
|
|
|
3331
3355
|
"immutable": true,
|
|
3332
3356
|
"locationInModule": {
|
|
3333
3357
|
"filename": "lib/application.ts",
|
|
3334
|
-
"line":
|
|
3358
|
+
"line": 64
|
|
3335
3359
|
},
|
|
3336
3360
|
"name": "description",
|
|
3337
3361
|
"optional": true,
|
|
@@ -3346,12 +3370,12 @@
|
|
|
3346
3370
|
"assembly": "@aws-cdk/aws-servicecatalogappregistry-alpha",
|
|
3347
3371
|
"base": "aws-cdk-lib.Resource",
|
|
3348
3372
|
"docs": {
|
|
3373
|
+
"stability": "experimental",
|
|
3374
|
+
"summary": "A Service Catalog AppRegistry Attribute Group.",
|
|
3375
|
+
"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});",
|
|
3349
3376
|
"custom": {
|
|
3350
3377
|
"exampleMetadata": "infused"
|
|
3351
|
-
}
|
|
3352
|
-
"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});",
|
|
3353
|
-
"stability": "experimental",
|
|
3354
|
-
"summary": "A Service Catalog AppRegistry Attribute Group."
|
|
3378
|
+
}
|
|
3355
3379
|
},
|
|
3356
3380
|
"fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.AttributeGroup",
|
|
3357
3381
|
"initializer": {
|
|
@@ -3360,7 +3384,7 @@
|
|
|
3360
3384
|
},
|
|
3361
3385
|
"locationInModule": {
|
|
3362
3386
|
"filename": "lib/attribute-group.ts",
|
|
3363
|
-
"line":
|
|
3387
|
+
"line": 122
|
|
3364
3388
|
},
|
|
3365
3389
|
"parameters": [
|
|
3366
3390
|
{
|
|
@@ -3389,7 +3413,7 @@
|
|
|
3389
3413
|
"kind": "class",
|
|
3390
3414
|
"locationInModule": {
|
|
3391
3415
|
"filename": "lib/attribute-group.ts",
|
|
3392
|
-
"line":
|
|
3416
|
+
"line": 93
|
|
3393
3417
|
},
|
|
3394
3418
|
"methods": [
|
|
3395
3419
|
{
|
|
@@ -3399,7 +3423,7 @@
|
|
|
3399
3423
|
},
|
|
3400
3424
|
"locationInModule": {
|
|
3401
3425
|
"filename": "lib/attribute-group.ts",
|
|
3402
|
-
"line":
|
|
3426
|
+
"line": 101
|
|
3403
3427
|
},
|
|
3404
3428
|
"name": "fromAttributeGroupArn",
|
|
3405
3429
|
"parameters": [
|
|
@@ -3437,6 +3461,51 @@
|
|
|
3437
3461
|
}
|
|
3438
3462
|
},
|
|
3439
3463
|
"static": true
|
|
3464
|
+
},
|
|
3465
|
+
{
|
|
3466
|
+
"docs": {
|
|
3467
|
+
"stability": "experimental",
|
|
3468
|
+
"summary": "Get the correct permission ARN based on the SharePermission."
|
|
3469
|
+
},
|
|
3470
|
+
"locationInModule": {
|
|
3471
|
+
"filename": "lib/attribute-group.ts",
|
|
3472
|
+
"line": 77
|
|
3473
|
+
},
|
|
3474
|
+
"name": "getAttributeGroupSharePermissionARN",
|
|
3475
|
+
"parameters": [
|
|
3476
|
+
{
|
|
3477
|
+
"name": "shareOptions",
|
|
3478
|
+
"type": {
|
|
3479
|
+
"fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.ShareOptions"
|
|
3480
|
+
}
|
|
3481
|
+
}
|
|
3482
|
+
],
|
|
3483
|
+
"protected": true,
|
|
3484
|
+
"returns": {
|
|
3485
|
+
"type": {
|
|
3486
|
+
"primitive": "string"
|
|
3487
|
+
}
|
|
3488
|
+
}
|
|
3489
|
+
},
|
|
3490
|
+
{
|
|
3491
|
+
"docs": {
|
|
3492
|
+
"stability": "experimental",
|
|
3493
|
+
"summary": "Share the attribute group resource with other IAM entities, accounts, or OUs."
|
|
3494
|
+
},
|
|
3495
|
+
"locationInModule": {
|
|
3496
|
+
"filename": "lib/attribute-group.ts",
|
|
3497
|
+
"line": 62
|
|
3498
|
+
},
|
|
3499
|
+
"name": "shareAttributeGroup",
|
|
3500
|
+
"overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IAttributeGroup",
|
|
3501
|
+
"parameters": [
|
|
3502
|
+
{
|
|
3503
|
+
"name": "shareOptions",
|
|
3504
|
+
"type": {
|
|
3505
|
+
"fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.ShareOptions"
|
|
3506
|
+
}
|
|
3507
|
+
}
|
|
3508
|
+
]
|
|
3440
3509
|
}
|
|
3441
3510
|
],
|
|
3442
3511
|
"name": "AttributeGroup",
|
|
@@ -3449,7 +3518,7 @@
|
|
|
3449
3518
|
"immutable": true,
|
|
3450
3519
|
"locationInModule": {
|
|
3451
3520
|
"filename": "lib/attribute-group.ts",
|
|
3452
|
-
"line":
|
|
3521
|
+
"line": 119
|
|
3453
3522
|
},
|
|
3454
3523
|
"name": "attributeGroupArn",
|
|
3455
3524
|
"overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IAttributeGroup",
|
|
@@ -3465,7 +3534,7 @@
|
|
|
3465
3534
|
"immutable": true,
|
|
3466
3535
|
"locationInModule": {
|
|
3467
3536
|
"filename": "lib/attribute-group.ts",
|
|
3468
|
-
"line":
|
|
3537
|
+
"line": 120
|
|
3469
3538
|
},
|
|
3470
3539
|
"name": "attributeGroupId",
|
|
3471
3540
|
"overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IAttributeGroup",
|
|
@@ -3480,18 +3549,18 @@
|
|
|
3480
3549
|
"assembly": "@aws-cdk/aws-servicecatalogappregistry-alpha",
|
|
3481
3550
|
"datatype": true,
|
|
3482
3551
|
"docs": {
|
|
3552
|
+
"stability": "experimental",
|
|
3553
|
+
"summary": "Properties for a Service Catalog AppRegistry Attribute Group.",
|
|
3554
|
+
"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});",
|
|
3483
3555
|
"custom": {
|
|
3484
3556
|
"exampleMetadata": "infused"
|
|
3485
|
-
}
|
|
3486
|
-
"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});",
|
|
3487
|
-
"stability": "experimental",
|
|
3488
|
-
"summary": "Properties for a Service Catalog AppRegistry Attribute Group."
|
|
3557
|
+
}
|
|
3489
3558
|
},
|
|
3490
3559
|
"fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.AttributeGroupProps",
|
|
3491
3560
|
"kind": "interface",
|
|
3492
3561
|
"locationInModule": {
|
|
3493
3562
|
"filename": "lib/attribute-group.ts",
|
|
3494
|
-
"line":
|
|
3563
|
+
"line": 39
|
|
3495
3564
|
},
|
|
3496
3565
|
"name": "AttributeGroupProps",
|
|
3497
3566
|
"properties": [
|
|
@@ -3504,7 +3573,7 @@
|
|
|
3504
3573
|
"immutable": true,
|
|
3505
3574
|
"locationInModule": {
|
|
3506
3575
|
"filename": "lib/attribute-group.ts",
|
|
3507
|
-
"line":
|
|
3576
|
+
"line": 43
|
|
3508
3577
|
},
|
|
3509
3578
|
"name": "attributeGroupName",
|
|
3510
3579
|
"type": {
|
|
@@ -3521,7 +3590,7 @@
|
|
|
3521
3590
|
"immutable": true,
|
|
3522
3591
|
"locationInModule": {
|
|
3523
3592
|
"filename": "lib/attribute-group.ts",
|
|
3524
|
-
"line":
|
|
3593
|
+
"line": 55
|
|
3525
3594
|
},
|
|
3526
3595
|
"name": "attributes",
|
|
3527
3596
|
"type": {
|
|
@@ -3543,7 +3612,7 @@
|
|
|
3543
3612
|
"immutable": true,
|
|
3544
3613
|
"locationInModule": {
|
|
3545
3614
|
"filename": "lib/attribute-group.ts",
|
|
3546
|
-
"line":
|
|
3615
|
+
"line": 49
|
|
3547
3616
|
},
|
|
3548
3617
|
"name": "description",
|
|
3549
3618
|
"optional": true,
|
|
@@ -3567,7 +3636,7 @@
|
|
|
3567
3636
|
"kind": "interface",
|
|
3568
3637
|
"locationInModule": {
|
|
3569
3638
|
"filename": "lib/application.ts",
|
|
3570
|
-
"line":
|
|
3639
|
+
"line": 16
|
|
3571
3640
|
},
|
|
3572
3641
|
"methods": [
|
|
3573
3642
|
{
|
|
@@ -3578,7 +3647,7 @@
|
|
|
3578
3647
|
},
|
|
3579
3648
|
"locationInModule": {
|
|
3580
3649
|
"filename": "lib/application.ts",
|
|
3581
|
-
"line":
|
|
3650
|
+
"line": 34
|
|
3582
3651
|
},
|
|
3583
3652
|
"name": "associateAttributeGroup",
|
|
3584
3653
|
"parameters": [
|
|
@@ -3601,7 +3670,7 @@
|
|
|
3601
3670
|
},
|
|
3602
3671
|
"locationInModule": {
|
|
3603
3672
|
"filename": "lib/application.ts",
|
|
3604
|
-
"line":
|
|
3673
|
+
"line": 41
|
|
3605
3674
|
},
|
|
3606
3675
|
"name": "associateStack",
|
|
3607
3676
|
"parameters": [
|
|
@@ -3615,6 +3684,29 @@
|
|
|
3615
3684
|
}
|
|
3616
3685
|
}
|
|
3617
3686
|
]
|
|
3687
|
+
},
|
|
3688
|
+
{
|
|
3689
|
+
"abstract": true,
|
|
3690
|
+
"docs": {
|
|
3691
|
+
"stability": "experimental",
|
|
3692
|
+
"summary": "Share this application with other IAM entities, accounts, or OUs."
|
|
3693
|
+
},
|
|
3694
|
+
"locationInModule": {
|
|
3695
|
+
"filename": "lib/application.ts",
|
|
3696
|
+
"line": 48
|
|
3697
|
+
},
|
|
3698
|
+
"name": "shareApplication",
|
|
3699
|
+
"parameters": [
|
|
3700
|
+
{
|
|
3701
|
+
"docs": {
|
|
3702
|
+
"summary": "The options for the share."
|
|
3703
|
+
},
|
|
3704
|
+
"name": "shareOptions",
|
|
3705
|
+
"type": {
|
|
3706
|
+
"fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.ShareOptions"
|
|
3707
|
+
}
|
|
3708
|
+
}
|
|
3709
|
+
]
|
|
3618
3710
|
}
|
|
3619
3711
|
],
|
|
3620
3712
|
"name": "IApplication",
|
|
@@ -3631,7 +3723,7 @@
|
|
|
3631
3723
|
"immutable": true,
|
|
3632
3724
|
"locationInModule": {
|
|
3633
3725
|
"filename": "lib/application.ts",
|
|
3634
|
-
"line":
|
|
3726
|
+
"line": 21
|
|
3635
3727
|
},
|
|
3636
3728
|
"name": "applicationArn",
|
|
3637
3729
|
"type": {
|
|
@@ -3650,7 +3742,7 @@
|
|
|
3650
3742
|
"immutable": true,
|
|
3651
3743
|
"locationInModule": {
|
|
3652
3744
|
"filename": "lib/application.ts",
|
|
3653
|
-
"line":
|
|
3745
|
+
"line": 27
|
|
3654
3746
|
},
|
|
3655
3747
|
"name": "applicationId",
|
|
3656
3748
|
"type": {
|
|
@@ -3673,8 +3765,33 @@
|
|
|
3673
3765
|
"kind": "interface",
|
|
3674
3766
|
"locationInModule": {
|
|
3675
3767
|
"filename": "lib/attribute-group.ts",
|
|
3676
|
-
"line":
|
|
3768
|
+
"line": 15
|
|
3677
3769
|
},
|
|
3770
|
+
"methods": [
|
|
3771
|
+
{
|
|
3772
|
+
"abstract": true,
|
|
3773
|
+
"docs": {
|
|
3774
|
+
"stability": "experimental",
|
|
3775
|
+
"summary": "Share the attribute group resource with other IAM entities, accounts, or OUs."
|
|
3776
|
+
},
|
|
3777
|
+
"locationInModule": {
|
|
3778
|
+
"filename": "lib/attribute-group.ts",
|
|
3779
|
+
"line": 33
|
|
3780
|
+
},
|
|
3781
|
+
"name": "shareAttributeGroup",
|
|
3782
|
+
"parameters": [
|
|
3783
|
+
{
|
|
3784
|
+
"docs": {
|
|
3785
|
+
"summary": "The options for the share."
|
|
3786
|
+
},
|
|
3787
|
+
"name": "shareOptions",
|
|
3788
|
+
"type": {
|
|
3789
|
+
"fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.ShareOptions"
|
|
3790
|
+
}
|
|
3791
|
+
}
|
|
3792
|
+
]
|
|
3793
|
+
}
|
|
3794
|
+
],
|
|
3678
3795
|
"name": "IAttributeGroup",
|
|
3679
3796
|
"properties": [
|
|
3680
3797
|
{
|
|
@@ -3689,7 +3806,7 @@
|
|
|
3689
3806
|
"immutable": true,
|
|
3690
3807
|
"locationInModule": {
|
|
3691
3808
|
"filename": "lib/attribute-group.ts",
|
|
3692
|
-
"line":
|
|
3809
|
+
"line": 20
|
|
3693
3810
|
},
|
|
3694
3811
|
"name": "attributeGroupArn",
|
|
3695
3812
|
"type": {
|
|
@@ -3708,7 +3825,7 @@
|
|
|
3708
3825
|
"immutable": true,
|
|
3709
3826
|
"locationInModule": {
|
|
3710
3827
|
"filename": "lib/attribute-group.ts",
|
|
3711
|
-
"line":
|
|
3828
|
+
"line": 26
|
|
3712
3829
|
},
|
|
3713
3830
|
"name": "attributeGroupId",
|
|
3714
3831
|
"type": {
|
|
@@ -3717,8 +3834,184 @@
|
|
|
3717
3834
|
}
|
|
3718
3835
|
],
|
|
3719
3836
|
"symbolId": "lib/attribute-group:IAttributeGroup"
|
|
3837
|
+
},
|
|
3838
|
+
"@aws-cdk/aws-servicecatalogappregistry-alpha.ShareOptions": {
|
|
3839
|
+
"assembly": "@aws-cdk/aws-servicecatalogappregistry-alpha",
|
|
3840
|
+
"datatype": true,
|
|
3841
|
+
"docs": {
|
|
3842
|
+
"stability": "experimental",
|
|
3843
|
+
"summary": "The options that are passed into a share of an Application or Attribute Group.",
|
|
3844
|
+
"example": "import * 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});",
|
|
3845
|
+
"custom": {
|
|
3846
|
+
"exampleMetadata": "infused"
|
|
3847
|
+
}
|
|
3848
|
+
},
|
|
3849
|
+
"fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.ShareOptions",
|
|
3850
|
+
"kind": "interface",
|
|
3851
|
+
"locationInModule": {
|
|
3852
|
+
"filename": "lib/common.ts",
|
|
3853
|
+
"line": 22
|
|
3854
|
+
},
|
|
3855
|
+
"name": "ShareOptions",
|
|
3856
|
+
"properties": [
|
|
3857
|
+
{
|
|
3858
|
+
"abstract": true,
|
|
3859
|
+
"docs": {
|
|
3860
|
+
"default": "- No accounts specified for share",
|
|
3861
|
+
"stability": "experimental",
|
|
3862
|
+
"summary": "A list of AWS accounts that the application will be shared with."
|
|
3863
|
+
},
|
|
3864
|
+
"immutable": true,
|
|
3865
|
+
"locationInModule": {
|
|
3866
|
+
"filename": "lib/common.ts",
|
|
3867
|
+
"line": 28
|
|
3868
|
+
},
|
|
3869
|
+
"name": "accounts",
|
|
3870
|
+
"optional": true,
|
|
3871
|
+
"type": {
|
|
3872
|
+
"collection": {
|
|
3873
|
+
"elementtype": {
|
|
3874
|
+
"primitive": "string"
|
|
3875
|
+
},
|
|
3876
|
+
"kind": "array"
|
|
3877
|
+
}
|
|
3878
|
+
}
|
|
3879
|
+
},
|
|
3880
|
+
{
|
|
3881
|
+
"abstract": true,
|
|
3882
|
+
"docs": {
|
|
3883
|
+
"default": "- No AWS Organizations or OUs specified for share",
|
|
3884
|
+
"stability": "experimental",
|
|
3885
|
+
"summary": "A list of AWS Organization or Organizational Units (OUs) ARNs that the application will be shared with."
|
|
3886
|
+
},
|
|
3887
|
+
"immutable": true,
|
|
3888
|
+
"locationInModule": {
|
|
3889
|
+
"filename": "lib/common.ts",
|
|
3890
|
+
"line": 35
|
|
3891
|
+
},
|
|
3892
|
+
"name": "organizationArns",
|
|
3893
|
+
"optional": true,
|
|
3894
|
+
"type": {
|
|
3895
|
+
"collection": {
|
|
3896
|
+
"elementtype": {
|
|
3897
|
+
"primitive": "string"
|
|
3898
|
+
},
|
|
3899
|
+
"kind": "array"
|
|
3900
|
+
}
|
|
3901
|
+
}
|
|
3902
|
+
},
|
|
3903
|
+
{
|
|
3904
|
+
"abstract": true,
|
|
3905
|
+
"docs": {
|
|
3906
|
+
"default": "- No IAM roles specified for share",
|
|
3907
|
+
"stability": "experimental",
|
|
3908
|
+
"summary": "A list of AWS IAM roles that the application will be shared with."
|
|
3909
|
+
},
|
|
3910
|
+
"immutable": true,
|
|
3911
|
+
"locationInModule": {
|
|
3912
|
+
"filename": "lib/common.ts",
|
|
3913
|
+
"line": 42
|
|
3914
|
+
},
|
|
3915
|
+
"name": "roles",
|
|
3916
|
+
"optional": true,
|
|
3917
|
+
"type": {
|
|
3918
|
+
"collection": {
|
|
3919
|
+
"elementtype": {
|
|
3920
|
+
"fqn": "aws-cdk-lib.aws_iam.IRole"
|
|
3921
|
+
},
|
|
3922
|
+
"kind": "array"
|
|
3923
|
+
}
|
|
3924
|
+
}
|
|
3925
|
+
},
|
|
3926
|
+
{
|
|
3927
|
+
"abstract": true,
|
|
3928
|
+
"docs": {
|
|
3929
|
+
"default": "- Principals will be assigned read only permissions on the application or attribute group.",
|
|
3930
|
+
"stability": "experimental",
|
|
3931
|
+
"summary": "An option to manage access to the application or attribute group."
|
|
3932
|
+
},
|
|
3933
|
+
"immutable": true,
|
|
3934
|
+
"locationInModule": {
|
|
3935
|
+
"filename": "lib/common.ts",
|
|
3936
|
+
"line": 49
|
|
3937
|
+
},
|
|
3938
|
+
"name": "sharePermission",
|
|
3939
|
+
"optional": true,
|
|
3940
|
+
"type": {
|
|
3941
|
+
"union": {
|
|
3942
|
+
"types": [
|
|
3943
|
+
{
|
|
3944
|
+
"primitive": "string"
|
|
3945
|
+
},
|
|
3946
|
+
{
|
|
3947
|
+
"fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.SharePermission"
|
|
3948
|
+
}
|
|
3949
|
+
]
|
|
3950
|
+
}
|
|
3951
|
+
}
|
|
3952
|
+
},
|
|
3953
|
+
{
|
|
3954
|
+
"abstract": true,
|
|
3955
|
+
"docs": {
|
|
3956
|
+
"default": "- No IAM Users specified for share",
|
|
3957
|
+
"stability": "experimental",
|
|
3958
|
+
"summary": "A list of AWS IAM users that the application will be shared with."
|
|
3959
|
+
},
|
|
3960
|
+
"immutable": true,
|
|
3961
|
+
"locationInModule": {
|
|
3962
|
+
"filename": "lib/common.ts",
|
|
3963
|
+
"line": 56
|
|
3964
|
+
},
|
|
3965
|
+
"name": "users",
|
|
3966
|
+
"optional": true,
|
|
3967
|
+
"type": {
|
|
3968
|
+
"collection": {
|
|
3969
|
+
"elementtype": {
|
|
3970
|
+
"fqn": "aws-cdk-lib.aws_iam.IUser"
|
|
3971
|
+
},
|
|
3972
|
+
"kind": "array"
|
|
3973
|
+
}
|
|
3974
|
+
}
|
|
3975
|
+
}
|
|
3976
|
+
],
|
|
3977
|
+
"symbolId": "lib/common:ShareOptions"
|
|
3978
|
+
},
|
|
3979
|
+
"@aws-cdk/aws-servicecatalogappregistry-alpha.SharePermission": {
|
|
3980
|
+
"assembly": "@aws-cdk/aws-servicecatalogappregistry-alpha",
|
|
3981
|
+
"docs": {
|
|
3982
|
+
"stability": "experimental",
|
|
3983
|
+
"summary": "Supported permissions for sharing applications or attribute groups with principals using AWS RAM.",
|
|
3984
|
+
"example": "import * 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});",
|
|
3985
|
+
"custom": {
|
|
3986
|
+
"exampleMetadata": "infused"
|
|
3987
|
+
}
|
|
3988
|
+
},
|
|
3989
|
+
"fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.SharePermission",
|
|
3990
|
+
"kind": "enum",
|
|
3991
|
+
"locationInModule": {
|
|
3992
|
+
"filename": "lib/common.ts",
|
|
3993
|
+
"line": 7
|
|
3994
|
+
},
|
|
3995
|
+
"members": [
|
|
3996
|
+
{
|
|
3997
|
+
"docs": {
|
|
3998
|
+
"stability": "experimental",
|
|
3999
|
+
"summary": "Allows principals in the share to only view the application or attribute group."
|
|
4000
|
+
},
|
|
4001
|
+
"name": "READ_ONLY"
|
|
4002
|
+
},
|
|
4003
|
+
{
|
|
4004
|
+
"docs": {
|
|
4005
|
+
"stability": "experimental",
|
|
4006
|
+
"summary": "Allows principals in the share to associate resources and attribute groups with applications."
|
|
4007
|
+
},
|
|
4008
|
+
"name": "ALLOW_ACCESS"
|
|
4009
|
+
}
|
|
4010
|
+
],
|
|
4011
|
+
"name": "SharePermission",
|
|
4012
|
+
"symbolId": "lib/common:SharePermission"
|
|
3720
4013
|
}
|
|
3721
4014
|
},
|
|
3722
|
-
"version": "2.
|
|
4015
|
+
"version": "2.40.0-alpha.0",
|
|
3723
4016
|
"fingerprint": "**********"
|
|
3724
4017
|
}
|