public static final class IPortfolio.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements IPortfolio.Jsii$Default
IPortfolio.Jsii$Default, IPortfolio.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) |
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.
|
public final ConstructNode getNode()
getNode
in interface IConstruct
getNode
in interface IConstruct.Jsii$Default
getNode
in interface IResource.Jsii$Default
getNode
in interface IPortfolio.Jsii$Default
public final ResourceEnvironment getEnv()
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.
getEnv
in interface IResource
getEnv
in interface IResource.Jsii$Default
getEnv
in interface IPortfolio.Jsii$Default
public final Stack getStack()
getStack
in interface IResource
getStack
in interface IResource.Jsii$Default
getStack
in interface IPortfolio.Jsii$Default
public final java.lang.String getPortfolioArn()
getPortfolioArn
in interface IPortfolio
getPortfolioArn
in interface IPortfolio.Jsii$Default
public final java.lang.String getPortfolioId()
getPortfolioId
in interface IPortfolio
getPortfolioId
in interface IPortfolio.Jsii$Default
public final void applyRemovalPolicy(RemovalPolicy policy)
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
).
applyRemovalPolicy
in interface IResource
applyRemovalPolicy
in interface IResource.Jsii$Default
applyRemovalPolicy
in interface IPortfolio.Jsii$Default
policy
- This parameter is required.public final void addProduct(IProduct product)
addProduct
in interface IPortfolio
addProduct
in interface IPortfolio.Jsii$Default
product
- A service catalog produt. This parameter is required.public final void associateTagOptions(TagOptions tagOptions)
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.
associateTagOptions
in interface IPortfolio
associateTagOptions
in interface IPortfolio.Jsii$Default
tagOptions
- This parameter is required.public final void constrainCloudFormationParameters(IProduct product, CloudFormationRuleConstraintOptions options)
constrainCloudFormationParameters
in interface IPortfolio
constrainCloudFormationParameters
in interface IPortfolio.Jsii$Default
product
- A service catalog product. This parameter is required.options
- options for the constraint. This parameter is required.public final void constrainTagUpdates(IProduct product, TagUpdateConstraintOptions options)
constrainTagUpdates
in interface IPortfolio
constrainTagUpdates
in interface IPortfolio.Jsii$Default
product
- This parameter is required.options
- public final void constrainTagUpdates(IProduct product)
constrainTagUpdates
in interface IPortfolio
product
- This parameter is required.public final void deployWithStackSets(IProduct product, StackSetsConstraintOptions options)
deployWithStackSets
in interface IPortfolio
deployWithStackSets
in interface IPortfolio.Jsii$Default
product
- A service catalog product. This parameter is required.options
- Configuration options for the constraint. This parameter is required.public final void giveAccessToGroup(IGroup group)
giveAccessToGroup
in interface IPortfolio
giveAccessToGroup
in interface IPortfolio.Jsii$Default
group
- an IAM Group. This parameter is required.public final void giveAccessToRole(IRole role)
giveAccessToRole
in interface IPortfolio
giveAccessToRole
in interface IPortfolio.Jsii$Default
role
- an IAM role. This parameter is required.public final void giveAccessToUser(IUser user)
giveAccessToUser
in interface IPortfolio
giveAccessToUser
in interface IPortfolio.Jsii$Default
user
- an IAM user. This parameter is required.public final void notifyOnStackEvents(IProduct product, ITopic topic, CommonConstraintOptions options)
notifyOnStackEvents
in interface IPortfolio
notifyOnStackEvents
in interface IPortfolio.Jsii$Default
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
- public final void notifyOnStackEvents(IProduct product, ITopic topic)
notifyOnStackEvents
in interface IPortfolio
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.public final void setLaunchRole(IProduct product, IRole launchRole, CommonConstraintOptions options)
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.
setLaunchRole
in interface IPortfolio
setLaunchRole
in interface IPortfolio.Jsii$Default
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.public final void setLaunchRole(IProduct product, IRole launchRole)
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.
setLaunchRole
in interface IPortfolio
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.public final void setLocalLaunchRole(IProduct product, IRole launchRole, CommonConstraintOptions options)
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.
setLocalLaunchRole
in interface IPortfolio
setLocalLaunchRole
in interface IPortfolio.Jsii$Default
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.public final void setLocalLaunchRole(IProduct product, IRole launchRole)
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.
setLocalLaunchRole
in interface IPortfolio
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.public final IRole setLocalLaunchRoleName(IProduct product, java.lang.String launchRoleName, CommonConstraintOptions options)
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.
setLocalLaunchRoleName
in interface IPortfolio
setLocalLaunchRoleName
in interface IPortfolio.Jsii$Default
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.public final IRole setLocalLaunchRoleName(IProduct product, java.lang.String launchRoleName)
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.
setLocalLaunchRoleName
in interface IPortfolio
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.public final void shareWithAccount(java.lang.String accountId, PortfolioShareOptions options)
shareWithAccount
in interface IPortfolio
shareWithAccount
in interface IPortfolio.Jsii$Default
accountId
- AWS account to share portfolio with. This parameter is required.options
- Options for the initiate share.public final void shareWithAccount(java.lang.String accountId)
shareWithAccount
in interface IPortfolio
accountId
- AWS account to share portfolio with. This parameter is required.