Skip navigation links

@Stability(value=Experimental)

Package software.amazon.awscdk.services.servicecatalog

AWS Service Catalog Construct Library

See: Description

Package software.amazon.awscdk.services.servicecatalog Description

AWS Service Catalog Construct Library

---

cfn-resources: Stable

All classes with the Cfn prefix in this module (CFN Resources) are always stable and safe to use.

cdk-constructs: Experimental

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 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.

AWS Service Catalog enables organizations to create and manage catalogs of products for their end users that are approved for use on AWS.

Table Of Contents

The @aws-cdk/aws-servicecatalog package contains resources that enable users to automate governance and management of their AWS resources at scale. 

 // Example automatically generated. See https://github.com/aws/jsii/issues/826
 import software.amazon.awscdk.services.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: 

 // Example automatically generated. See https://github.com/aws/jsii/issues/826
 Portfolio.Builder.create(this, "MyFirstPortfolio")
         .displayName("MyFirstPortfolio")
         .providerName("MyTeam")
         .build();

You can also specify properties such as description and acceptLanguage to help better catalog and manage your portfolios. 

 // Example automatically generated. See https://github.com/aws/jsii/issues/826
 Portfolio.Builder.create(this, "MyFirstPortfolio")
         .displayName("MyFirstPortfolio")
         .providerName("MyTeam")
         .description("Portfolio for a project")
         .acceptLanguage(servicecatalog.AcceptLanguage.getEN())
         .build();

Read more at Creating and Managing Portfolios.

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: 

 // Example automatically generated. See https://github.com/aws/jsii/issues/826
 Object 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. 

 // Example automatically generated. See https://github.com/aws/jsii/issues/826
 import software.amazon.awscdk.services.iam.*;
 
 
 User user = new User(this, "MyUser");
 portfolio.giveAccessToUser(user);
 
 Role role = new Role(this, "MyRole", new RoleProps()
         .assumedBy(new AccountRootPrincipal()));
 portfolio.giveAccessToRole(role);
 
 Group group = new 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: 

 // Example automatically generated. See https://github.com/aws/jsii/issues/826
 portfolio.shareWithAccount("012345678901");

Product

Products are the resources you are allowing end users to provision and utilize. The CDK currently only supports adding products of type Cloudformation product. Using the CDK, a new Product can be created with the CloudFormationProduct construct. CloudFormationTemplate.fromUrl can be utilized to create a Product using a Cloudformation template directly from an URL: 

 // Example automatically generated. See https://github.com/aws/jsii/issues/826
 Object product = CloudFormationProduct.Builder.create(this, "MyFirstProduct")
         .productName("My Product")
         .owner("Product Owner")
         .productVersions(asList(Map.of(
                 "productVersionName", "v1",
                 "cloudFormationTemplate", servicecatalog.CloudFormationTemplate.fromUrl("https://raw.githubusercontent.com/awslabs/aws-cloudformation-templates/master/aws/services/ServiceCatalog/Product.yaml"))))
         .build();

A CloudFormationProduct can also be created using a Cloudformation template from an Asset. Assets are files that are uploaded to an S3 Bucket before deployment. CloudFormationTemplate.fromAsset can be utilized to create a Product by passing the path to a local template file on your disk: 

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 Object product = CloudFormationProduct.Builder.create(this, "MyFirstProduct")
         .productName("My Product")
         .owner("Product Owner")
         .productVersions(asList(Map.of(
                 "productVersionName", "v1",
                 "cloudFormationTemplate", servicecatalog.CloudFormationTemplate.fromUrl("https://raw.githubusercontent.com/awslabs/aws-cloudformation-templates/master/aws/services/ServiceCatalog/Product.yaml")), Map.of(
                 "productVersionName", "v2",
                 "cloudFormationTemplate", servicecatalog.CloudFormationTemplate.fromAsset(path.join(__dirname, "development-environment.template.json")))))
         .build();
Skip navigation links

Copyright © 2021. All rights reserved.