software.amazon.awscdk.services.servicecatalog

Interface IPortfolio.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IPortfolio, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IPortfolio.Jsii$Proxy

Enclosing interface:

IPortfolio

@Internal
public static interface IPortfolio.Jsii$Default
extends IPortfolio, IResource.Jsii$Default

Internal default implementation for IPortfolio.

Nested Class Summary

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

IPortfolio.Jsii$Default, IPortfolio.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default ResourceEnvironment	getEnv() The environment this resource belongs to.
default ConstructNode	getNode() The construct tree node for this construct.
default String	getPortfolioArn() (experimental) The ARN of the portfolio.
default String	getPortfolioId() (experimental) The ID of the portfolio.
default Stack	getStack() The stack in which this resource is defined.
default void	giveAccessToGroup(IGroup group) (experimental) Associate portfolio with an IAM Group.
default void	giveAccessToRole(IRole role) (experimental) Associate portfolio with an IAM Role.
default void	giveAccessToUser(IUser user) (experimental) Associate portfolio with an IAM User.
default void	shareWithAccount(String accountId, PortfolioShareOptions options) (experimental) Initiate a portfolio share with another account.

Methods inherited from interface software.amazon.awscdk.services.servicecatalog.IPortfolio

shareWithAccount

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Stable)
 @NotNull
default ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(value=Stable)
 @NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getPortfolioArn

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

(experimental) The ARN of the portfolio.

Specified by:

getPortfolioArn in interface IPortfolio

getPortfolioId

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

(experimental) The ID of the portfolio.

Specified by:

getPortfolioId in interface IPortfolio

giveAccessToGroup

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

(experimental) Associate portfolio with an IAM Group.

Specified by:

giveAccessToGroup in interface IPortfolio

Parameters:

group - an IAM Group. This parameter is required.

giveAccessToRole

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

(experimental) Associate portfolio with an IAM Role.

Specified by:

giveAccessToRole in interface IPortfolio

Parameters:

role - an IAM role. This parameter is required.

giveAccessToUser

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

(experimental) Associate portfolio with an IAM User.

Specified by:

giveAccessToUser in interface IPortfolio

Parameters:

user - an IAM user. This parameter is required.

shareWithAccount

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

(experimental) Initiate a portfolio share with another account.

Specified by:

shareWithAccount in interface IPortfolio

Parameters:

accountId - AWS account to share portfolio with. This parameter is required.

options - Options for the initiate share.