@aws-cdk/aws-servicecatalogappregistry-alpha 2.44.0-alpha.0 → 2.45.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 CHANGED
@@ -8,7 +8,7 @@
8
8
  "url": "https://aws.amazon.com"
9
9
  },
10
10
  "dependencies": {
11
- "aws-cdk-lib": "^2.44.0",
11
+ "aws-cdk-lib": "^2.45.0",
12
12
  "constructs": "^10.0.0"
13
13
  },
14
14
  "dependencyClosure": {
@@ -730,6 +730,19 @@
730
730
  }
731
731
  }
732
732
  },
733
+ "aws-cdk-lib.aws_connectcampaigns": {
734
+ "targets": {
735
+ "dotnet": {
736
+ "namespace": "Amazon.CDK.AWS.ConnectCampaigns"
737
+ },
738
+ "java": {
739
+ "package": "software.amazon.awscdk.services.connectcampaigns"
740
+ },
741
+ "python": {
742
+ "module": "aws_cdk.aws_connectcampaigns"
743
+ }
744
+ }
745
+ },
733
746
  "aws-cdk-lib.aws_controltower": {
734
747
  "targets": {
735
748
  "dotnet": {
@@ -1510,6 +1523,19 @@
1510
1523
  }
1511
1524
  }
1512
1525
  },
1526
+ "aws-cdk-lib.aws_iotfleetwise": {
1527
+ "targets": {
1528
+ "dotnet": {
1529
+ "namespace": "Amazon.CDK.AWS.IoTFleetWise"
1530
+ },
1531
+ "java": {
1532
+ "package": "software.amazon.awscdk.services.iotfleetwise"
1533
+ },
1534
+ "python": {
1535
+ "module": "aws_cdk.aws_iotfleetwise"
1536
+ }
1537
+ }
1538
+ },
1513
1539
  "aws-cdk-lib.aws_iotsitewise": {
1514
1540
  "targets": {
1515
1541
  "dotnet": {
@@ -2303,6 +2329,19 @@
2303
2329
  }
2304
2330
  }
2305
2331
  },
2332
+ "aws-cdk-lib.aws_rolesanywhere": {
2333
+ "targets": {
2334
+ "dotnet": {
2335
+ "namespace": "Amazon.CDK.AWS.RolesAnywhere"
2336
+ },
2337
+ "java": {
2338
+ "package": "software.amazon.awscdk.services.rolesanywhere"
2339
+ },
2340
+ "python": {
2341
+ "module": "aws_cdk.aws_rolesanywhere"
2342
+ }
2343
+ }
2344
+ },
2306
2345
  "aws-cdk-lib.aws_route53": {
2307
2346
  "targets": {
2308
2347
  "dotnet": {
@@ -3085,7 +3124,7 @@
3085
3124
  },
3086
3125
  "name": "@aws-cdk/aws-servicecatalogappregistry-alpha",
3087
3126
  "readme": {
3088
- "markdown": "# AWS ServiceCatalogAppRegistry Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)\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"
3127
+ "markdown": "# AWS ServiceCatalogAppRegistry Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)\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- [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 applicationName: 'MyAssociatedApplication',\n description: 'Testing associated application',\n stackProps: {\n stackName: 'MyAssociatedApplicationStack',\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 applicationArnValue: 'arn:aws:servicecatalog:us-east-1:123456789012:/applications/applicationId',\n stackProps: {\n stackName: 'MyAssociatedApplicationStack',\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 applicationName: 'MyPipelineAssociatedApplication',\n description: 'Testing pipeline associated app',\n stackProps: {\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-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"
3089
3128
  },
3090
3129
  "repository": {
3091
3130
  "directory": "packages/individual-packages/aws-servicecatalogappregistry",
@@ -3143,7 +3182,7 @@
3143
3182
  },
3144
3183
  "locationInModule": {
3145
3184
  "filename": "lib/application.ts",
3146
- "line": 181
3185
+ "line": 259
3147
3186
  },
3148
3187
  "parameters": [
3149
3188
  {
@@ -3172,7 +3211,7 @@
3172
3211
  "kind": "class",
3173
3212
  "locationInModule": {
3174
3213
  "filename": "lib/application.ts",
3175
- "line": 147
3214
+ "line": 223
3176
3215
  },
3177
3216
  "methods": [
3178
3217
  {
@@ -3182,7 +3221,7 @@
3182
3221
  },
3183
3222
  "locationInModule": {
3184
3223
  "filename": "lib/application.ts",
3185
- "line": 155
3224
+ "line": 231
3186
3225
  },
3187
3226
  "name": "fromApplicationArn",
3188
3227
  "parameters": [
@@ -3221,6 +3260,48 @@
3221
3260
  },
3222
3261
  "static": true
3223
3262
  },
3263
+ {
3264
+ "docs": {
3265
+ "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.",
3266
+ "stability": "experimental",
3267
+ "summary": "Associate all stacks present in construct's aspect with application."
3268
+ },
3269
+ "locationInModule": {
3270
+ "filename": "lib/application.ts",
3271
+ "line": 180
3272
+ },
3273
+ "name": "associateAllStacksInScope",
3274
+ "overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication",
3275
+ "parameters": [
3276
+ {
3277
+ "name": "scope",
3278
+ "type": {
3279
+ "fqn": "constructs.Construct"
3280
+ }
3281
+ }
3282
+ ]
3283
+ },
3284
+ {
3285
+ "docs": {
3286
+ "remarks": "If the stack is already associated, it will ignore duplicate request.\nA stack can only be associated with one application.",
3287
+ "stability": "experimental",
3288
+ "summary": "Associate stack with the application in the stack passed as parameter."
3289
+ },
3290
+ "locationInModule": {
3291
+ "filename": "lib/application.ts",
3292
+ "line": 140
3293
+ },
3294
+ "name": "associateApplicationWithStack",
3295
+ "overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication",
3296
+ "parameters": [
3297
+ {
3298
+ "name": "stack",
3299
+ "type": {
3300
+ "fqn": "aws-cdk-lib.Stack"
3301
+ }
3302
+ }
3303
+ ]
3304
+ },
3224
3305
  {
3225
3306
  "docs": {
3226
3307
  "stability": "experimental",
@@ -3228,7 +3309,7 @@
3228
3309
  },
3229
3310
  "locationInModule": {
3230
3311
  "filename": "lib/application.ts",
3231
- "line": 77
3312
+ "line": 104
3232
3313
  },
3233
3314
  "name": "associateAttributeGroup",
3234
3315
  "overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication",
@@ -3243,13 +3324,14 @@
3243
3324
  },
3244
3325
  {
3245
3326
  "docs": {
3327
+ "deprecated": "Use `associateApplicationWithStack` instead.",
3246
3328
  "remarks": "A stack can only be associated with one application.",
3247
- "stability": "experimental",
3329
+ "stability": "deprecated",
3248
3330
  "summary": "Associate a stack with the application If the resource is already associated, it will ignore duplicate request."
3249
3331
  },
3250
3332
  "locationInModule": {
3251
3333
  "filename": "lib/application.ts",
3252
- "line": 93
3334
+ "line": 122
3253
3335
  },
3254
3336
  "name": "associateStack",
3255
3337
  "overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication",
@@ -3269,7 +3351,7 @@
3269
3351
  },
3270
3352
  "locationInModule": {
3271
3353
  "filename": "lib/application.ts",
3272
- "line": 196
3354
+ "line": 275
3273
3355
  },
3274
3356
  "name": "generateUniqueHash",
3275
3357
  "parameters": [
@@ -3295,7 +3377,7 @@
3295
3377
  },
3296
3378
  "locationInModule": {
3297
3379
  "filename": "lib/application.ts",
3298
- "line": 111
3380
+ "line": 161
3299
3381
  },
3300
3382
  "name": "shareApplication",
3301
3383
  "overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication",
@@ -3322,7 +3404,7 @@
3322
3404
  "immutable": true,
3323
3405
  "locationInModule": {
3324
3406
  "filename": "lib/application.ts",
3325
- "line": 177
3407
+ "line": 254
3326
3408
  },
3327
3409
  "name": "applicationArn",
3328
3410
  "overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication",
@@ -3338,17 +3420,243 @@
3338
3420
  "immutable": true,
3339
3421
  "locationInModule": {
3340
3422
  "filename": "lib/application.ts",
3341
- "line": 178
3423
+ "line": 255
3342
3424
  },
3343
3425
  "name": "applicationId",
3344
3426
  "overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication",
3345
3427
  "type": {
3346
3428
  "primitive": "string"
3347
3429
  }
3430
+ },
3431
+ {
3432
+ "docs": {
3433
+ "stability": "experimental",
3434
+ "summary": "The name of the application."
3435
+ },
3436
+ "immutable": true,
3437
+ "locationInModule": {
3438
+ "filename": "lib/application.ts",
3439
+ "line": 256
3440
+ },
3441
+ "name": "applicationName",
3442
+ "optional": true,
3443
+ "overrides": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication",
3444
+ "type": {
3445
+ "primitive": "string"
3446
+ }
3348
3447
  }
3349
3448
  ],
3350
3449
  "symbolId": "lib/application:Application"
3351
3450
  },
3451
+ "@aws-cdk/aws-servicecatalogappregistry-alpha.ApplicationAssociator": {
3452
+ "assembly": "@aws-cdk/aws-servicecatalogappregistry-alpha",
3453
+ "base": "constructs.Construct",
3454
+ "docs": {
3455
+ "remarks": "The application name must be unique at the account level 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, then this construct will automatically share the application to consumer accounts.\nCross account feature will only work for non environment agnostic stacks.",
3456
+ "stability": "experimental",
3457
+ "summary": "An AppRegistry construct to automatically create an application with the given name and description.",
3458
+ "example": "const app = new App();\nconst associatedApp = new appreg.ApplicationAssociator(app, 'AssociatedApplication', {\n applicationName: 'MyAssociatedApplication',\n description: 'Testing associated application',\n stackProps: {\n stackName: 'MyAssociatedApplicationStack',\n env: {account: '123456789012', region: 'us-east-1'},\n },\n});",
3459
+ "custom": {
3460
+ "exampleMetadata": "infused"
3461
+ }
3462
+ },
3463
+ "fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.ApplicationAssociator",
3464
+ "initializer": {
3465
+ "docs": {
3466
+ "stability": "experimental"
3467
+ },
3468
+ "locationInModule": {
3469
+ "filename": "lib/application-associator.ts",
3470
+ "line": 56
3471
+ },
3472
+ "parameters": [
3473
+ {
3474
+ "name": "scope",
3475
+ "type": {
3476
+ "fqn": "aws-cdk-lib.App"
3477
+ }
3478
+ },
3479
+ {
3480
+ "name": "id",
3481
+ "type": {
3482
+ "primitive": "string"
3483
+ }
3484
+ },
3485
+ {
3486
+ "name": "props",
3487
+ "type": {
3488
+ "fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.ApplicationAssociatorProps"
3489
+ }
3490
+ }
3491
+ ]
3492
+ },
3493
+ "kind": "class",
3494
+ "locationInModule": {
3495
+ "filename": "lib/application-associator.ts",
3496
+ "line": 49
3497
+ },
3498
+ "methods": [
3499
+ {
3500
+ "docs": {
3501
+ "stability": "experimental",
3502
+ "summary": "Associate this application with the given stage."
3503
+ },
3504
+ "locationInModule": {
3505
+ "filename": "lib/application-associator.ts",
3506
+ "line": 79
3507
+ },
3508
+ "name": "associateStage",
3509
+ "parameters": [
3510
+ {
3511
+ "name": "stage",
3512
+ "type": {
3513
+ "fqn": "aws-cdk-lib.Stage"
3514
+ }
3515
+ }
3516
+ ],
3517
+ "returns": {
3518
+ "type": {
3519
+ "fqn": "aws-cdk-lib.Stage"
3520
+ }
3521
+ }
3522
+ },
3523
+ {
3524
+ "docs": {
3525
+ "stability": "experimental",
3526
+ "summary": "Validates if a stage is already associated to the application."
3527
+ },
3528
+ "locationInModule": {
3529
+ "filename": "lib/application-associator.ts",
3530
+ "line": 89
3531
+ },
3532
+ "name": "isStageAssociated",
3533
+ "parameters": [
3534
+ {
3535
+ "name": "stage",
3536
+ "type": {
3537
+ "fqn": "aws-cdk-lib.Stage"
3538
+ }
3539
+ }
3540
+ ],
3541
+ "returns": {
3542
+ "type": {
3543
+ "primitive": "boolean"
3544
+ }
3545
+ }
3546
+ }
3547
+ ],
3548
+ "name": "ApplicationAssociator",
3549
+ "properties": [
3550
+ {
3551
+ "docs": {
3552
+ "stability": "experimental",
3553
+ "summary": "Get the AppRegistry application."
3554
+ },
3555
+ "immutable": true,
3556
+ "locationInModule": {
3557
+ "filename": "lib/application-associator.ts",
3558
+ "line": 97
3559
+ },
3560
+ "name": "appRegistryApplication",
3561
+ "type": {
3562
+ "fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.IApplication"
3563
+ }
3564
+ }
3565
+ ],
3566
+ "symbolId": "lib/application-associator:ApplicationAssociator"
3567
+ },
3568
+ "@aws-cdk/aws-servicecatalogappregistry-alpha.ApplicationAssociatorProps": {
3569
+ "assembly": "@aws-cdk/aws-servicecatalogappregistry-alpha",
3570
+ "datatype": true,
3571
+ "docs": {
3572
+ "stability": "experimental",
3573
+ "summary": "Properties for a Service Catalog AppRegistry AutoApplication.",
3574
+ "example": "const app = new App();\nconst associatedApp = new appreg.ApplicationAssociator(app, 'AssociatedApplication', {\n applicationName: 'MyAssociatedApplication',\n description: 'Testing associated application',\n stackProps: {\n stackName: 'MyAssociatedApplicationStack',\n env: {account: '123456789012', region: 'us-east-1'},\n },\n});",
3575
+ "custom": {
3576
+ "exampleMetadata": "infused"
3577
+ }
3578
+ },
3579
+ "fqn": "@aws-cdk/aws-servicecatalogappregistry-alpha.ApplicationAssociatorProps",
3580
+ "kind": "interface",
3581
+ "locationInModule": {
3582
+ "filename": "lib/application-associator.ts",
3583
+ "line": 9
3584
+ },
3585
+ "name": "ApplicationAssociatorProps",
3586
+ "properties": [
3587
+ {
3588
+ "abstract": true,
3589
+ "docs": {
3590
+ "stability": "experimental",
3591
+ "summary": "Stack properties."
3592
+ },
3593
+ "immutable": true,
3594
+ "locationInModule": {
3595
+ "filename": "lib/application-associator.ts",
3596
+ "line": 35
3597
+ },
3598
+ "name": "stackProps",
3599
+ "type": {
3600
+ "fqn": "aws-cdk-lib.StackProps"
3601
+ }
3602
+ },
3603
+ {
3604
+ "abstract": true,
3605
+ "docs": {
3606
+ "default": "- No application arn.",
3607
+ "stability": "experimental",
3608
+ "summary": "Enforces a particular application arn."
3609
+ },
3610
+ "immutable": true,
3611
+ "locationInModule": {
3612
+ "filename": "lib/application-associator.ts",
3613
+ "line": 22
3614
+ },
3615
+ "name": "applicationArnValue",
3616
+ "optional": true,
3617
+ "type": {
3618
+ "primitive": "string"
3619
+ }
3620
+ },
3621
+ {
3622
+ "abstract": true,
3623
+ "docs": {
3624
+ "default": "- No name.",
3625
+ "stability": "experimental",
3626
+ "summary": "Enforces a particular physical application name."
3627
+ },
3628
+ "immutable": true,
3629
+ "locationInModule": {
3630
+ "filename": "lib/application-associator.ts",
3631
+ "line": 15
3632
+ },
3633
+ "name": "applicationName",
3634
+ "optional": true,
3635
+ "type": {
3636
+ "primitive": "string"
3637
+ }
3638
+ },
3639
+ {
3640
+ "abstract": true,
3641
+ "docs": {
3642
+ "default": "- No description.",
3643
+ "stability": "experimental",
3644
+ "summary": "Application description."
3645
+ },
3646
+ "immutable": true,
3647
+ "locationInModule": {
3648
+ "filename": "lib/application-associator.ts",
3649
+ "line": 29
3650
+ },
3651
+ "name": "description",
3652
+ "optional": true,
3653
+ "type": {
3654
+ "primitive": "string"
3655
+ }
3656
+ }
3657
+ ],
3658
+ "symbolId": "lib/application-associator:ApplicationAssociatorProps"
3659
+ },
3352
3660
  "@aws-cdk/aws-servicecatalogappregistry-alpha.ApplicationProps": {
3353
3661
  "assembly": "@aws-cdk/aws-servicecatalogappregistry-alpha",
3354
3662
  "datatype": true,
@@ -3364,7 +3672,7 @@
3364
3672
  "kind": "interface",
3365
3673
  "locationInModule": {
3366
3674
  "filename": "lib/application.ts",
3367
- "line": 54
3675
+ "line": 80
3368
3676
  },
3369
3677
  "name": "ApplicationProps",
3370
3678
  "properties": [
@@ -3377,7 +3685,7 @@
3377
3685
  "immutable": true,
3378
3686
  "locationInModule": {
3379
3687
  "filename": "lib/application.ts",
3380
- "line": 58
3688
+ "line": 84
3381
3689
  },
3382
3690
  "name": "applicationName",
3383
3691
  "type": {
@@ -3394,7 +3702,7 @@
3394
3702
  "immutable": true,
3395
3703
  "locationInModule": {
3396
3704
  "filename": "lib/application.ts",
3397
- "line": 64
3705
+ "line": 90
3398
3706
  },
3399
3707
  "name": "description",
3400
3708
  "optional": true,
@@ -3675,18 +3983,65 @@
3675
3983
  "kind": "interface",
3676
3984
  "locationInModule": {
3677
3985
  "filename": "lib/application.ts",
3678
- "line": 16
3986
+ "line": 18
3679
3987
  },
3680
3988
  "methods": [
3989
+ {
3990
+ "abstract": true,
3991
+ "docs": {
3992
+ "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.",
3993
+ "stability": "experimental",
3994
+ "summary": "Associate this application with all stacks under the construct node."
3995
+ },
3996
+ "locationInModule": {
3997
+ "filename": "lib/application.ts",
3998
+ "line": 73
3999
+ },
4000
+ "name": "associateAllStacksInScope",
4001
+ "parameters": [
4002
+ {
4003
+ "docs": {
4004
+ "summary": "cdk Construct."
4005
+ },
4006
+ "name": "construct",
4007
+ "type": {
4008
+ "fqn": "constructs.Construct"
4009
+ }
4010
+ }
4011
+ ]
4012
+ },
4013
+ {
4014
+ "abstract": true,
4015
+ "docs": {
4016
+ "stability": "experimental",
4017
+ "summary": "Associate a Cloudformation statck with the application in the given stack."
4018
+ },
4019
+ "locationInModule": {
4020
+ "filename": "lib/application.ts",
4021
+ "line": 57
4022
+ },
4023
+ "name": "associateApplicationWithStack",
4024
+ "parameters": [
4025
+ {
4026
+ "docs": {
4027
+ "summary": "a CFN stack."
4028
+ },
4029
+ "name": "stack",
4030
+ "type": {
4031
+ "fqn": "aws-cdk-lib.Stack"
4032
+ }
4033
+ }
4034
+ ]
4035
+ },
3681
4036
  {
3682
4037
  "abstract": true,
3683
4038
  "docs": {
3684
4039
  "stability": "experimental",
3685
- "summary": "Associate thisapplication with an attribute group."
4040
+ "summary": "Associate this application with an attribute group."
3686
4041
  },
3687
4042
  "locationInModule": {
3688
4043
  "filename": "lib/application.ts",
3689
- "line": 34
4044
+ "line": 42
3690
4045
  },
3691
4046
  "name": "associateAttributeGroup",
3692
4047
  "parameters": [
@@ -3704,12 +4059,13 @@
3704
4059
  {
3705
4060
  "abstract": true,
3706
4061
  "docs": {
3707
- "stability": "experimental",
4062
+ "deprecated": "Use `associateApplicationWithStack` instead.",
4063
+ "stability": "deprecated",
3708
4064
  "summary": "Associate this application with a CloudFormation stack."
3709
4065
  },
3710
4066
  "locationInModule": {
3711
4067
  "filename": "lib/application.ts",
3712
- "line": 41
4068
+ "line": 50
3713
4069
  },
3714
4070
  "name": "associateStack",
3715
4071
  "parameters": [
@@ -3732,7 +4088,7 @@
3732
4088
  },
3733
4089
  "locationInModule": {
3734
4090
  "filename": "lib/application.ts",
3735
- "line": 48
4091
+ "line": 64
3736
4092
  },
3737
4093
  "name": "shareApplication",
3738
4094
  "parameters": [
@@ -3762,7 +4118,7 @@
3762
4118
  "immutable": true,
3763
4119
  "locationInModule": {
3764
4120
  "filename": "lib/application.ts",
3765
- "line": 21
4121
+ "line": 23
3766
4122
  },
3767
4123
  "name": "applicationArn",
3768
4124
  "type": {
@@ -3781,12 +4137,32 @@
3781
4137
  "immutable": true,
3782
4138
  "locationInModule": {
3783
4139
  "filename": "lib/application.ts",
3784
- "line": 27
4140
+ "line": 29
3785
4141
  },
3786
4142
  "name": "applicationId",
3787
4143
  "type": {
3788
4144
  "primitive": "string"
3789
4145
  }
4146
+ },
4147
+ {
4148
+ "abstract": true,
4149
+ "docs": {
4150
+ "custom": {
4151
+ "attribute": "true"
4152
+ },
4153
+ "stability": "experimental",
4154
+ "summary": "The name of the application."
4155
+ },
4156
+ "immutable": true,
4157
+ "locationInModule": {
4158
+ "filename": "lib/application.ts",
4159
+ "line": 35
4160
+ },
4161
+ "name": "applicationName",
4162
+ "optional": true,
4163
+ "type": {
4164
+ "primitive": "string"
4165
+ }
3790
4166
  }
3791
4167
  ],
3792
4168
  "symbolId": "lib/application:IApplication"
@@ -4051,6 +4427,6 @@
4051
4427
  "symbolId": "lib/common:SharePermission"
4052
4428
  }
4053
4429
  },
4054
- "version": "2.44.0-alpha.0",
4430
+ "version": "2.45.0-alpha.0",
4055
4431
  "fingerprint": "**********"
4056
4432
  }
Binary file
package/.warnings.jsii.js CHANGED
@@ -10,6 +10,10 @@ function _aws_cdk_aws_servicecatalogappregistry_alpha_AttributeGroupProps(p) {
10
10
  }
11
11
  function _aws_cdk_aws_servicecatalogappregistry_alpha_AttributeGroup(p) {
12
12
  }
13
+ function _aws_cdk_aws_servicecatalogappregistry_alpha_ApplicationAssociatorProps(p) {
14
+ }
15
+ function _aws_cdk_aws_servicecatalogappregistry_alpha_ApplicationAssociator(p) {
16
+ }
13
17
  function _aws_cdk_aws_servicecatalogappregistry_alpha_SharePermission(p) {
14
18
  }
15
19
  function _aws_cdk_aws_servicecatalogappregistry_alpha_ShareOptions(p) {
@@ -62,4 +66,4 @@ class DeprecationError extends Error {
62
66
  });
63
67
  }
64
68
  }
65
- module.exports = { print, getPropertyDescriptor, DeprecationError, _aws_cdk_aws_servicecatalogappregistry_alpha_IApplication, _aws_cdk_aws_servicecatalogappregistry_alpha_ApplicationProps, _aws_cdk_aws_servicecatalogappregistry_alpha_Application, _aws_cdk_aws_servicecatalogappregistry_alpha_IAttributeGroup, _aws_cdk_aws_servicecatalogappregistry_alpha_AttributeGroupProps, _aws_cdk_aws_servicecatalogappregistry_alpha_AttributeGroup, _aws_cdk_aws_servicecatalogappregistry_alpha_SharePermission, _aws_cdk_aws_servicecatalogappregistry_alpha_ShareOptions };
69
+ module.exports = { print, getPropertyDescriptor, DeprecationError, _aws_cdk_aws_servicecatalogappregistry_alpha_IApplication, _aws_cdk_aws_servicecatalogappregistry_alpha_ApplicationProps, _aws_cdk_aws_servicecatalogappregistry_alpha_Application, _aws_cdk_aws_servicecatalogappregistry_alpha_IAttributeGroup, _aws_cdk_aws_servicecatalogappregistry_alpha_AttributeGroupProps, _aws_cdk_aws_servicecatalogappregistry_alpha_AttributeGroup, _aws_cdk_aws_servicecatalogappregistry_alpha_ApplicationAssociatorProps, _aws_cdk_aws_servicecatalogappregistry_alpha_ApplicationAssociator, _aws_cdk_aws_servicecatalogappregistry_alpha_SharePermission, _aws_cdk_aws_servicecatalogappregistry_alpha_ShareOptions };