software.amazon.awscdk.services.servicecatalog

Class Portfolio

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.servicecatalog.Portfolio

All Implemented Interfaces:

IDependable, IResource, IPortfolio, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-07-09T19:17:58.080Z")
 @Stability(value=Experimental)
public class Portfolio
extends Resource
implements IPortfolio

(experimental) A Service Catalog portfolio.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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
	Portfolio(software.constructs.Construct scope, String id, PortfolioProps props)
protected	Portfolio(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Portfolio(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static IPortfolio	fromPortfolioArn(software.constructs.Construct scope, String id, String portfolioArn) (experimental) Creates a Portfolio construct that represents an external portfolio.
protected String	generateUniqueHash(String value) (experimental) Create a unique id based off the L1 CfnPortfolio or the arn of an imported portfolio.
String	getPortfolioArn() (experimental) The ARN of the portfolio.
String	getPortfolioId() (experimental) The ID of the portfolio.
void	giveAccessToGroup(IGroup group) (experimental) Associate portfolio with an IAM Group.
void	giveAccessToRole(IRole role) (experimental) Associate portfolio with an IAM Role.
void	giveAccessToUser(IUser user) (experimental) Associate portfolio with an IAM User.
void	shareWithAccount(String accountId) (experimental) Initiate a portfolio share with another account.
void	shareWithAccount(String accountId, PortfolioShareOptions options) (experimental) 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 software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

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

getEnv, getStack

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

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Portfolio

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

Portfolio

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

Portfolio

@Stability(value=Experimental)
public Portfolio(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                PortfolioProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromPortfolioArn

@Stability(value=Experimental)
 @NotNull
public static IPortfolio fromPortfolioArn(@NotNull
                                                                                   software.constructs.Construct scope,
                                                                                   @NotNull
                                                                                   String id,
                                                                                   @NotNull
                                                                                   String portfolioArn)

(experimental) 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.

generateUniqueHash

@Stability(value=Experimental)
 @NotNull
protected String generateUniqueHash(@NotNull
                                                                             String value)

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

Parameters:

value - This parameter is required.

giveAccessToGroup

@Stability(value=Experimental)
public void giveAccessToGroup(@NotNull
                                                             IGroup group)

(experimental) Associate portfolio with an IAM Group.

Specified by:

giveAccessToGroup in interface IPortfolio

Parameters:

group - This parameter is required.

giveAccessToRole

@Stability(value=Experimental)
public void giveAccessToRole(@NotNull
                                                            IRole role)

(experimental) Associate portfolio with an IAM Role.

Specified by:

giveAccessToRole in interface IPortfolio

Parameters:

role - This parameter is required.

giveAccessToUser

@Stability(value=Experimental)
public void giveAccessToUser(@NotNull
                                                            IUser user)

(experimental) Associate portfolio with an IAM User.

Specified by:

giveAccessToUser in interface IPortfolio

Parameters:

user - This parameter is required.

shareWithAccount

@Stability(value=Experimental)
public void shareWithAccount(@NotNull
                                                            String accountId,
                                                            @Nullable
                                                            PortfolioShareOptions options)

(experimental) Initiate a portfolio share with another account.

Specified by:

shareWithAccount in interface IPortfolio

Parameters:

accountId - This parameter is required.

options -

shareWithAccount

@Stability(value=Experimental)
public void shareWithAccount(@NotNull
                                                            String accountId)

(experimental) Initiate a portfolio share with another account.

Specified by:

shareWithAccount in interface IPortfolio

Parameters:

accountId - This parameter is required.

getPortfolioArn

@Stability(value=Experimental)
 @NotNull
public String getPortfolioArn()

(experimental) The ARN of the portfolio.

Specified by:

getPortfolioArn in interface IPortfolio

getPortfolioId

@Stability(value=Experimental)
 @NotNull
public String getPortfolioId()

(experimental) The ID of the portfolio.

Specified by:

getPortfolioId in interface IPortfolio