software.amazon.awscdk.services.servicecatalog

Interface IPortfolio

All Superinterfaces:

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

All Known Subinterfaces:

IPortfolio.Jsii$Default

All Known Implementing Classes:

IPortfolio.Jsii$Proxy, Portfolio

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-07-09T19:17:58.079Z")
 @Stability(value=Experimental)
public interface IPortfolio
extends software.amazon.jsii.JsiiSerializable, IResource

(experimental) A Service Catalog portfolio.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IPortfolio.Jsii$Default Internal default implementation for IPortfolio.
static class	IPortfolio.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
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 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

Method Detail

getPortfolioArn

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

(experimental) The ARN of the portfolio.

getPortfolioId

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

(experimental) The ID of the portfolio.

giveAccessToGroup

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

(experimental) Associate portfolio with an IAM Group.

Parameters:

group - an IAM Group. This parameter is required.

giveAccessToRole

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

(experimental) Associate portfolio with an IAM Role.

Parameters:

role - an IAM role. This parameter is required.

giveAccessToUser

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

(experimental) Associate portfolio with an IAM User.

Parameters:

user - an IAM user. This parameter is required.

shareWithAccount

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

(experimental) Initiate a portfolio share with another account.

Parameters:

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

options - Options for the initiate share.

shareWithAccount

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

(experimental) Initiate a portfolio share with another account.

Parameters:

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