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 void	addProduct(IProduct product) (experimental) Associate portfolio with the given product.
default void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
default void	associateTagOptions(TagOptions tagOptions) (experimental) Associate Tag Options.
default void	constrainCloudFormationParameters(IProduct product, CloudFormationRuleConstraintOptions options) (experimental) Set provisioning rules for the product.
default void	constrainTagUpdates(IProduct product, TagUpdateConstraintOptions options) (experimental) Add a Resource Update Constraint.
default void	deployWithStackSets(IProduct product, StackSetsConstraintOptions options) (experimental) Configure deployment options using AWS Cloudformation StackSets.
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	notifyOnStackEvents(IProduct product, ITopic topic, CommonConstraintOptions options) (experimental) Add notifications for supplied topics on the provisioned product.
default void	setLaunchRole(IProduct product, IRole launchRole, CommonConstraintOptions options) (experimental) Force users to assume a certain role when launching a product.
default void	setLocalLaunchRole(IProduct product, IRole launchRole, CommonConstraintOptions options) (experimental) Force users to assume a certain role when launching a product.
default IRole	setLocalLaunchRoleName(IProduct product, String launchRoleName, CommonConstraintOptions options) (experimental) Force users to assume a certain role when launching a product.
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

constrainTagUpdates, notifyOnStackEvents, setLaunchRole, setLocalLaunchRole, setLocalLaunchRoleName, 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

applyRemovalPolicy

@Stability(value=Stable)
default void applyRemovalPolicy(@NotNull
                                                         RemovalPolicy policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

addProduct

@Stability(value=Experimental)
default void addProduct(@NotNull
                                                       IProduct product)

(experimental) Associate portfolio with the given product.

Specified by:

addProduct in interface IPortfolio

Parameters:

product - A service catalog produt. This parameter is required.

associateTagOptions

@Stability(value=Experimental)
default void associateTagOptions(@NotNull
                                                                TagOptions tagOptions)

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

@Stability(value=Experimental)
default void constrainCloudFormationParameters(@NotNull
                                                                              IProduct product,
                                                                              @NotNull
                                                                              CloudFormationRuleConstraintOptions options)

(experimental) Set provisioning rules for the product.

Specified by:

constrainCloudFormationParameters in interface IPortfolio

Parameters:

product - A service catalog product. This parameter is required.

options - options for the constraint. This parameter is required.

constrainTagUpdates

@Stability(value=Experimental)
default void constrainTagUpdates(@NotNull
                                                                IProduct product,
                                                                @Nullable
                                                                TagUpdateConstraintOptions options)

(experimental) Add a Resource Update Constraint.

Specified by:

constrainTagUpdates in interface IPortfolio

Parameters:

product - This parameter is required.

options -

deployWithStackSets

@Stability(value=Experimental)
default void deployWithStackSets(@NotNull
                                                                IProduct product,
                                                                @NotNull
                                                                StackSetsConstraintOptions options)

(experimental) Configure deployment options using AWS Cloudformation StackSets.

Specified by:

deployWithStackSets in interface IPortfolio

Parameters:

product - A service catalog product. This parameter is required.

options - Configuration options for the constraint. This parameter is required.

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.

notifyOnStackEvents

@Stability(value=Experimental)
default void notifyOnStackEvents(@NotNull
                                                                IProduct product,
                                                                @NotNull
                                                                ITopic topic,
                                                                @Nullable
                                                                CommonConstraintOptions options)

(experimental) Add notifications for supplied topics on the provisioned product.

Specified by:

notifyOnStackEvents in interface IPortfolio

Parameters:

product - A service catalog product. This parameter is required.

topic - A SNS Topic to receive notifications on events related to the provisioned product. This parameter is required.

options -

setLaunchRole

@Stability(value=Experimental)
default void setLaunchRole(@NotNull
                                                          IProduct product,
                                                          @NotNull
                                                          IRole launchRole,
                                                          @Nullable
                                                          CommonConstraintOptions options)

(experimental) 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 - A service catalog product. This parameter is required.

launchRole - The IAM role a user must assume when provisioning the product. This parameter is required.

options - options for the constraint.

setLocalLaunchRole

@Stability(value=Experimental)
default void setLocalLaunchRole(@NotNull
                                                               IProduct product,
                                                               @NotNull
                                                               IRole launchRole,
                                                               @Nullable
                                                               CommonConstraintOptions options)

(experimental) 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 - A service catalog product. This parameter is required.

launchRole - The IAM role a user must assume when provisioning the product. This parameter is required.

options - options for the constraint.

setLocalLaunchRoleName

@Stability(value=Experimental)
 @NotNull
default IRole setLocalLaunchRoleName(@NotNull
                                                                              IProduct product,
                                                                              @NotNull
                                                                              String launchRoleName,
                                                                              @Nullable
                                                                              CommonConstraintOptions options)

(experimental) 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 - A service catalog product. This parameter is required.

launchRoleName - The name of the IAM role a user must assume when provisioning the product. This parameter is required.

options - options for the constraint.

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.