software.amazon.awscdk.services.servicecatalog

Class IPortfolio.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.servicecatalog.IPortfolio.Jsii$Proxy

All Implemented Interfaces:

IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, IPortfolio, IPortfolio.Jsii$Default

Enclosing interface:

IPortfolio

public static final class IPortfolio.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IPortfolio.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

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	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addProduct(IProduct product) Associate portfolio with the given product.
void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
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.
ResourceEnvironment	getEnv() The environment this resource belongs to.
ConstructNode	getNode() The construct tree node for this construct.
java.lang.String	getPortfolioArn() The ARN of the portfolio.
java.lang.String	getPortfolioId() The ID of the portfolio.
Stack	getStack() The stack in which this resource is defined.
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 java.lang.Object

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

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Detail

getNode

public final ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IConstruct

Specified by:

getNode in interface IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface IPortfolio.Jsii$Default

getEnv

public final 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

Specified by:

getEnv in interface IPortfolio.Jsii$Default

getStack

public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IPortfolio.Jsii$Default

getPortfolioArn

public final java.lang.String getPortfolioArn()

The ARN of the portfolio.

Specified by:

getPortfolioArn in interface IPortfolio

Specified by:

getPortfolioArn in interface IPortfolio.Jsii$Default

getPortfolioId

public final java.lang.String getPortfolioId()

The ID of the portfolio.

Specified by:

getPortfolioId in interface IPortfolio

Specified by:

getPortfolioId in interface IPortfolio.Jsii$Default

applyRemovalPolicy

public final void applyRemovalPolicy(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

Specified by:

applyRemovalPolicy in interface IPortfolio.Jsii$Default

Parameters:

policy - This parameter is required.

addProduct

public final void addProduct(IProduct product)

Associate portfolio with the given product.

Specified by:

addProduct in interface IPortfolio

Specified by:

addProduct in interface IPortfolio.Jsii$Default

Parameters:

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

associateTagOptions

public final 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

Specified by:

associateTagOptions in interface IPortfolio.Jsii$Default

Parameters:

tagOptions - This parameter is required.

constrainCloudFormationParameters

public final void constrainCloudFormationParameters(IProduct product,
                                                    CloudFormationRuleConstraintOptions options)

Set provisioning rules for the product.

Specified by:

constrainCloudFormationParameters in interface IPortfolio

Specified by:

constrainCloudFormationParameters in interface IPortfolio.Jsii$Default

Parameters:

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

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

constrainTagUpdates

public final void constrainTagUpdates(IProduct product,
                                      TagUpdateConstraintOptions options)

Add a Resource Update Constraint.

Specified by:

constrainTagUpdates in interface IPortfolio

Specified by:

constrainTagUpdates in interface IPortfolio.Jsii$Default

Parameters:

product - This parameter is required.

options -

constrainTagUpdates

public final void constrainTagUpdates(IProduct product)

Add a Resource Update Constraint.

Specified by:

constrainTagUpdates in interface IPortfolio

Parameters:

product - This parameter is required.

deployWithStackSets

public final void deployWithStackSets(IProduct product,
                                      StackSetsConstraintOptions options)

Configure deployment options using AWS Cloudformation StackSets.

Specified by:

deployWithStackSets in interface IPortfolio

Specified by:

deployWithStackSets in interface IPortfolio.Jsii$Default

Parameters:

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

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

giveAccessToGroup

public final void giveAccessToGroup(IGroup group)

Associate portfolio with an IAM Group.

Specified by:

giveAccessToGroup in interface IPortfolio

Specified by:

giveAccessToGroup in interface IPortfolio.Jsii$Default

Parameters:

group - an IAM Group. This parameter is required.

giveAccessToRole

public final void giveAccessToRole(IRole role)

Associate portfolio with an IAM Role.

Specified by:

giveAccessToRole in interface IPortfolio

Specified by:

giveAccessToRole in interface IPortfolio.Jsii$Default

Parameters:

role - an IAM role. This parameter is required.

giveAccessToUser

public final void giveAccessToUser(IUser user)

Associate portfolio with an IAM User.

Specified by:

giveAccessToUser in interface IPortfolio

Specified by:

giveAccessToUser in interface IPortfolio.Jsii$Default

Parameters:

user - an IAM user. This parameter is required.

notifyOnStackEvents

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

Add notifications for supplied topics on the provisioned product.

Specified by:

notifyOnStackEvents in interface IPortfolio

Specified by:

notifyOnStackEvents in interface IPortfolio.Jsii$Default

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 -

notifyOnStackEvents

public final void notifyOnStackEvents(IProduct product,
                                      ITopic topic)

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.

setLaunchRole

public final 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

Specified by:

setLaunchRole in interface IPortfolio.Jsii$Default

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.

setLaunchRole

public final 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 - A service catalog product. This parameter is required.

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

setLocalLaunchRole

public final 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

Specified by:

setLocalLaunchRole in interface IPortfolio.Jsii$Default

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

public final 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 - A service catalog product. This parameter is required.

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

setLocalLaunchRoleName

public final 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

Specified by:

setLocalLaunchRoleName in interface IPortfolio.Jsii$Default

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.

setLocalLaunchRoleName

public final 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 - 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.

shareWithAccount

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

Initiate a portfolio share with another account.

Specified by:

shareWithAccount in interface IPortfolio

Specified by:

shareWithAccount in interface IPortfolio.Jsii$Default

Parameters:

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

options - Options for the initiate share.

shareWithAccount

public final void shareWithAccount(java.lang.String accountId)

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.