software.amazon.awscdk.services.servicecatalog

Class Portfolio

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.servicecatalog.Portfolio

All Implemented Interfaces:

IConstruct, IDependable, IResource, IPortfolio

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:53.742Z")
public class Portfolio
extends Resource
implements IPortfolio

A Service Catalog portfolio.

Example:

 Portfolio.Builder.create(this, "Portfolio")
         .displayName("MyPortfolio")
         .providerName("MyTeam")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Portfolio.Builder A fluent builder for Portfolio.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.servicecatalog.IPortfolio

IPortfolio.Jsii$Default, IPortfolio.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Portfolio(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Portfolio(software.amazon.jsii.JsiiObjectRef objRef)
	Portfolio(software.constructs.Construct scope, java.lang.String id, PortfolioProps props)

Method Summary

Modifier and Type	Method and Description
void	addProduct(IProduct product) Associate portfolio with the given product.
void	associateTagOptions(TagOptions tagOptions) Associate Tag Options.
void	constrainCloudFormationParameters(IProduct product, CloudFormationRuleConstraintOptions options) Set provisioning rules for the product.
void	constrainTagUpdates(IProduct product) Add a Resource Update Constraint.
void	constrainTagUpdates(IProduct product, TagUpdateConstraintOptions options) Add a Resource Update Constraint.
void	deployWithStackSets(IProduct product, StackSetsConstraintOptions options) Configure deployment options using AWS Cloudformation StackSets.
static IPortfolio	fromPortfolioArn(software.constructs.Construct scope, java.lang.String id, java.lang.String portfolioArn) Creates a Portfolio construct that represents an external portfolio.
protected java.lang.String	generateUniqueHash(java.lang.String value) Create a unique id based off the L1 CfnPortfolio or the arn of an imported portfolio.
java.lang.String	getPortfolioArn() The ARN of the portfolio.
java.lang.String	getPortfolioId() The ID of the portfolio.
void	giveAccessToGroup(IGroup group) Associate portfolio with an IAM Group.
void	giveAccessToRole(IRole role) Associate portfolio with an IAM Role.
void	giveAccessToUser(IUser user) Associate portfolio with an IAM User.
void	notifyOnStackEvents(IProduct product, ITopic topic) Add notifications for supplied topics on the provisioned product.
void	notifyOnStackEvents(IProduct product, ITopic topic, CommonConstraintOptions options) Add notifications for supplied topics on the provisioned product.
void	setLaunchRole(IProduct product, IRole launchRole) Force users to assume a certain role when launching a product.
void	setLaunchRole(IProduct product, IRole launchRole, CommonConstraintOptions options) Force users to assume a certain role when launching a product.
void	setLocalLaunchRole(IProduct product, IRole launchRole) Force users to assume a certain role when launching a product.
void	setLocalLaunchRole(IProduct product, IRole launchRole, CommonConstraintOptions options) Force users to assume a certain role when launching a product.
IRole	setLocalLaunchRoleName(IProduct product, java.lang.String launchRoleName) Force users to assume a certain role when launching a product.
IRole	setLocalLaunchRoleName(IProduct product, java.lang.String launchRoleName, CommonConstraintOptions options) Force users to assume a certain role when launching a product.
void	shareWithAccount(java.lang.String accountId) Initiate a portfolio share with another account.
void	shareWithAccount(java.lang.String accountId, PortfolioShareOptions options) Initiate a portfolio share with another account.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

Portfolio

protected Portfolio(software.amazon.jsii.JsiiObjectRef objRef)

Portfolio

protected Portfolio(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Portfolio

public Portfolio(software.constructs.Construct scope,
                 java.lang.String id,
                 PortfolioProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromPortfolioArn

public static IPortfolio fromPortfolioArn(software.constructs.Construct scope,
                                          java.lang.String id,
                                          java.lang.String portfolioArn)

Creates a Portfolio construct that represents an external portfolio.

Parameters:

scope - The parent creating construct (usually `this`). This parameter is required.

id - The construct's name. This parameter is required.

portfolioArn - the Amazon Resource Name of the existing portfolio. This parameter is required.

addProduct

public void addProduct(IProduct product)

Associate portfolio with the given product.

Specified by:

addProduct in interface IPortfolio

Parameters:

product - This parameter is required.

associateTagOptions

public void associateTagOptions(TagOptions tagOptions)

Associate Tag Options.

A TagOption is a key-value pair managed in AWS Service Catalog. It is not an AWS tag, but serves as a template for creating an AWS tag based on the TagOption.

Specified by:

associateTagOptions in interface IPortfolio

Parameters:

tagOptions - This parameter is required.

constrainCloudFormationParameters

public void constrainCloudFormationParameters(IProduct product,
                                              CloudFormationRuleConstraintOptions options)

Set provisioning rules for the product.

Specified by:

constrainCloudFormationParameters in interface IPortfolio

Parameters:

product - This parameter is required.

options - This parameter is required.

constrainTagUpdates

public void constrainTagUpdates(IProduct product,
                                TagUpdateConstraintOptions options)

Add a Resource Update Constraint.

Specified by:

constrainTagUpdates in interface IPortfolio

Parameters:

product - This parameter is required.

options -

constrainTagUpdates

public void constrainTagUpdates(IProduct product)

Add a Resource Update Constraint.

Specified by:

constrainTagUpdates in interface IPortfolio

Parameters:

product - This parameter is required.

deployWithStackSets

public void deployWithStackSets(IProduct product,
                                StackSetsConstraintOptions options)

Configure deployment options using AWS Cloudformation StackSets.

Specified by:

deployWithStackSets in interface IPortfolio

Parameters:

product - This parameter is required.

options - This parameter is required.

generateUniqueHash

protected java.lang.String generateUniqueHash(java.lang.String value)

Create a unique id based off the L1 CfnPortfolio or the arn of an imported portfolio.

Parameters:

value - This parameter is required.

giveAccessToGroup

public void giveAccessToGroup(IGroup group)

Associate portfolio with an IAM Group.

Specified by:

giveAccessToGroup in interface IPortfolio

Parameters:

group - This parameter is required.

giveAccessToRole

public void giveAccessToRole(IRole role)

Associate portfolio with an IAM Role.

Specified by:

giveAccessToRole in interface IPortfolio

Parameters:

role - This parameter is required.

giveAccessToUser

public void giveAccessToUser(IUser user)

Associate portfolio with an IAM User.

Specified by:

giveAccessToUser in interface IPortfolio

Parameters:

user - This parameter is required.

notifyOnStackEvents

public void notifyOnStackEvents(IProduct product,
                                ITopic topic,
                                CommonConstraintOptions options)

Add notifications for supplied topics on the provisioned product.

Specified by:

notifyOnStackEvents in interface IPortfolio

Parameters:

product - This parameter is required.

topic - This parameter is required.

options -

notifyOnStackEvents

public void notifyOnStackEvents(IProduct product,
                                ITopic topic)

Add notifications for supplied topics on the provisioned product.

Specified by:

notifyOnStackEvents in interface IPortfolio

Parameters:

product - This parameter is required.

topic - This parameter is required.

setLaunchRole

public void setLaunchRole(IProduct product,
                          IRole launchRole,
                          CommonConstraintOptions options)

Force users to assume a certain role when launching a product.

This sets the launch role using the role arn which is tied to the account this role exists in. This is useful if you will be provisioning products from the account where this role exists. If you intend to share the portfolio across accounts, use a local launch role.

Specified by:

setLaunchRole in interface IPortfolio

Parameters:

product - This parameter is required.

launchRole - This parameter is required.

options -

setLaunchRole

public void setLaunchRole(IProduct product,
                          IRole launchRole)

Force users to assume a certain role when launching a product.

This sets the launch role using the role arn which is tied to the account this role exists in. This is useful if you will be provisioning products from the account where this role exists. If you intend to share the portfolio across accounts, use a local launch role.

Specified by:

setLaunchRole in interface IPortfolio

Parameters:

product - This parameter is required.

launchRole - This parameter is required.

setLocalLaunchRole

public void setLocalLaunchRole(IProduct product,
                               IRole launchRole,
                               CommonConstraintOptions options)

Force users to assume a certain role when launching a product.

The role name will be referenced by in the local account and must be set explicitly. This is useful when sharing the portfolio with multiple accounts.

Specified by:

setLocalLaunchRole in interface IPortfolio

Parameters:

product - This parameter is required.

launchRole - This parameter is required.

options -

setLocalLaunchRole

public void setLocalLaunchRole(IProduct product,
                               IRole launchRole)

Force users to assume a certain role when launching a product.

The role name will be referenced by in the local account and must be set explicitly. This is useful when sharing the portfolio with multiple accounts.

Specified by:

setLocalLaunchRole in interface IPortfolio

Parameters:

product - This parameter is required.

launchRole - This parameter is required.

setLocalLaunchRoleName

public IRole setLocalLaunchRoleName(IProduct product,
                                    java.lang.String launchRoleName,
                                    CommonConstraintOptions options)

Force users to assume a certain role when launching a product.

The role will be referenced by name in the local account instead of a static role arn. A role with this name will automatically be created and assumable by Service Catalog in this account. This is useful when sharing the portfolio with multiple accounts.

Specified by:

setLocalLaunchRoleName in interface IPortfolio

Parameters:

product - This parameter is required.

launchRoleName - This parameter is required.

options -

setLocalLaunchRoleName

public IRole setLocalLaunchRoleName(IProduct product,
                                    java.lang.String launchRoleName)

Force users to assume a certain role when launching a product.

The role will be referenced by name in the local account instead of a static role arn. A role with this name will automatically be created and assumable by Service Catalog in this account. This is useful when sharing the portfolio with multiple accounts.

Specified by:

setLocalLaunchRoleName in interface IPortfolio

Parameters:

product - This parameter is required.

launchRoleName - This parameter is required.

shareWithAccount

public void shareWithAccount(java.lang.String accountId,
                             PortfolioShareOptions options)

Initiate a portfolio share with another account.

Specified by:

shareWithAccount in interface IPortfolio

Parameters:

accountId - This parameter is required.

options -

shareWithAccount

public void shareWithAccount(java.lang.String accountId)

Initiate a portfolio share with another account.

Specified by:

shareWithAccount in interface IPortfolio

Parameters:

accountId - This parameter is required.

getPortfolioArn

public java.lang.String getPortfolioArn()

The ARN of the portfolio.

Specified by:

getPortfolioArn in interface IPortfolio

getPortfolioId

public java.lang.String getPortfolioId()

The ID of the portfolio.

Specified by:

getPortfolioId in interface IPortfolio