@aws-cdk/aws-servicecatalog - npm Package Compare versions

Comparing version 1.108.1 to 1.109.0

lib/index.d.ts

@@ -0,1 +1,3 @@
+export * from './common';
+export * from './portfolio';
 export * from './servicecatalog.generated';

lib/index.js

@@ -13,4 +13,6 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./common"), exports);
+__exportStar(require("./portfolio"), exports);
 // AWS::ServiceCatalog CloudFormation Resources:
 __exportStar(require("./servicecatalog.generated"), exports);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJpbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7QUFBQSxnREFBZ0Q7QUFDaEQsNkRBQTJDIiwic291cmNlc0NvbnRlbnQiOlsiLy8gQVdTOjpTZXJ2aWNlQ2F0YWxvZyBDbG91ZEZvcm1hdGlvbiBSZXNvdXJjZXM6XG5leHBvcnQgKiBmcm9tICcuL3NlcnZpY2VjYXRhbG9nLmdlbmVyYXRlZCc7XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJpbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7QUFBQSwyQ0FBeUI7QUFDekIsOENBQTRCO0FBRTVCLGdEQUFnRDtBQUNoRCw2REFBMkMiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgKiBmcm9tICcuL2NvbW1vbic7XG5leHBvcnQgKiBmcm9tICcuL3BvcnRmb2xpbyc7XG5cbi8vIEFXUzo6U2VydmljZUNhdGFsb2cgQ2xvdWRGb3JtYXRpb24gUmVzb3VyY2VzOlxuZXhwb3J0ICogZnJvbSAnLi9zZXJ2aWNlY2F0YWxvZy5nZW5lcmF0ZWQnO1xuIl19

package.json

 {
   "name": "@aws-cdk/aws-servicecatalog",
-  "version": "1.108.1",
+  "version": "1.109.0",
   "description": "The CDK Construct Library for AWS::ServiceCatalog",
@@ -52,3 +52,5 @@ "main": "lib/index.js",
     "gen": "cfn2ts",
-    "rosetta:extract": "yarn --silent jsii-rosetta extract"
+    "rosetta:extract": "yarn --silent jsii-rosetta extract",
+    "build+extract": "yarn build && yarn rosetta:extract",
+    "build+test+extract": "yarn build+test && yarn rosetta:extract"
   },
@@ -76,9 +78,11 @@ "cdk-build": {
     "@types/jest": "^26.0.23",
-    "cdk-build-tools": "1.108.1",
-    "cfn2ts": "1.108.1",
-    "pkglint": "1.108.1",
-    "@aws-cdk/assert-internal": "1.108.1"
+    "cdk-build-tools": "1.109.0",
+    "cdk-integ-tools": "1.109.0",
+    "cfn2ts": "1.109.0",
+    "pkglint": "1.109.0",
+    "@aws-cdk/assert-internal": "1.109.0"
   },
   "dependencies": {
-    "@aws-cdk/core": "1.108.1",
+    "@aws-cdk/aws-iam": "1.109.0",
+    "@aws-cdk/core": "1.109.0",
     "constructs": "^3.3.69"
@@ -88,3 +92,4 @@ },
   "peerDependencies": {
-    "@aws-cdk/core": "1.108.1",
+    "@aws-cdk/aws-iam": "1.109.0",
+    "@aws-cdk/core": "1.109.0",
     "constructs": "^3.3.69"
@@ -95,4 +100,10 @@ },
   },
+  "awslint": {
+    "exclude": [
+      "resource-attribute:@aws-cdk/aws-servicecatalog.Portfolio.portfolioName",
+      "props-physical-name:@aws-cdk/aws-servicecatalog.PortfolioProps"
+    ]
+  },
+  "maturity": "experimental",
   "stability": "experimental",
-  "maturity": "cfn-only",
   "awscdkio": {
@@ -99,0 +110,0 @@ "announce": false

README.md

@@ -12,2 +12,10 @@ # AWS Service Catalog Construct Library
 
+![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)
+
+> The APIs of higher level constructs in this module are experimental and under active development.
+> They are subject to non-backward compatible changes or removal in any future version. These are
+> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be
+> announced in the release notes. This means that while you may use them, you may need to update
+> your source code when upgrading to a newer version of this package.
+
 ---
@@ -17,2 +25,77 @@
 
-This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.
+[AWS Service Catalog](https://docs.aws.amazon.com/servicecatalog/latest/dg/what-is-service-catalog.html)
+enables organizations to create and manage catalogs of products for their end users that are approved for use on AWS.
+
+## Table Of Contents
+
+- [Portfolio](#portfolio)
+  - [Granting access to a portfolio](#granting-access-to-a-portfolio)
+  - [Sharing a portfolio with another AWS account](#sharing-a-portfolio-with-another-aws-account)
+
+The `@aws-cdk/aws-servicecatalog` package contains resources that enable users to automate governance and management of their AWS resources at scale.
+
+```ts nofixture
+import * as servicecatalog from '@aws-cdk/aws-servicecatalog';
+```
+
+## Portfolio
+
+AWS Service Catalog portfolios allow admins to manage products that their end users have access to.
+Using the CDK, a new portfolio can be created with the `Portfolio` construct:
+
+```ts
+new servicecatalog.Portfolio(this, 'MyFirstPortfolio', {
+  displayName: 'MyFirstPortfolio',
+  providerName: 'MyTeam',
+});
+```
+
+You can also specify properties such as `description` and `acceptLanguage`
+to help better catalog and manage your portfolios.
+
+```ts
+new servicecatalog.Portfolio(this, 'MyFirstPortfolio', {
+  displayName: 'MyFirstPortfolio',
+  providerName: 'MyTeam',
+  description: 'Portfolio for a project',
+  acceptLanguage: servicecatalog.AcceptLanguage.EN,
+});
+```
+
+Read more at [Creating and Managing Portfolios](https://docs.aws.amazon.com/servicecatalog/latest/adminguide/catalogs_portfolios.html).
+
+A portfolio that has been created outside the stack can be imported into your CDK app.
+Portfolios can be imported by their ARN via the `Portfolio.fromPortfolioArn()` API:
+
+```ts
+const portfolio = servicecatalog.Portfolio.fromPortfolioArn(this, 'MyImportedPortfolio',
+  'arn:aws:catalog:region:account-id:portfolio/port-abcdefghi');
+```
+
+### Granting access to a portfolio
+
+You can manage end user access to a portfolio by granting permissions to `IAM` entities like a user, group, or role.
+Once resources are deployed end users will be able to access them via the console or service catalog CLI.
+
+```ts fixture=basic-portfolio
+import * as iam from '@aws-cdk/aws-iam';
+
+const user = new iam.User(this, 'MyUser');
+portfolio.giveAccessToUser(user);
+
+const role = new iam.Role(this, 'MyRole', {
+  assumedBy: new iam.AccountRootPrincipal(),
+});
+portfolio.giveAccessToRole(role);
+
+const group = new iam.Group(this, 'MyGroup');
+portfolio.giveAccessToGroup(group);
+```
+
+### Sharing a portfolio with another AWS account
+
+A portfolio can be programatically shared with other accounts so that specified users can also access it:
+
+```ts fixture=basic-portfolio
+portfolio.shareWithAccount('012345678901');
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

908960

increased by6.24%

Number of package files

21

increased by90.91%

Lines of code

5353

increased by8.47%

Number of lines in readme file

100

increased by488.24%

Worsened metrics

Dependency count

6

increased by50%

Dev dependency count

6

increased by20%

Dependency changes

• + Added@aws-cdk/aws-iam@1.109.0

• + Added@aws-cdk/aws-iam@1.109.0(transitive)

• + Added@aws-cdk/cloud-assembly-schema@1.109.0(transitive)

• + Added@aws-cdk/core@1.109.0(transitive)

• + Added@aws-cdk/cx-api@1.109.0(transitive)

• + Added@aws-cdk/region-info@1.109.0(transitive)

• - Removed@aws-cdk/cloud-assembly-schema@1.108.1(transitive)

• - Removed@aws-cdk/core@1.108.1(transitive)

• - Removed@aws-cdk/cx-api@1.108.1(transitive)

• - Removed@aws-cdk/region-info@1.108.1(transitive)

• Updated@aws-cdk/core@1.109.0