public static interface IPortfolio.Jsii$Default extends IPortfolio, IResource.Jsii$Default
IPortfolio
.IPortfolio.Jsii$Default, IPortfolio.Jsii$Proxy
Modifier and Type | Method and Description |
---|---|
default void |
addProduct(IProduct product)
Associate portfolio with the given product.
|
default void |
applyRemovalPolicy(RemovalPolicy policy)
Apply the given removal policy to this resource.
|
default void |
associateTagOptions(TagOptions tagOptions)
Associate Tag Options.
|
default void |
constrainCloudFormationParameters(IProduct product,
CloudFormationRuleConstraintOptions options)
Set provisioning rules for the product.
|
default void |
constrainTagUpdates(IProduct product,
TagUpdateConstraintOptions options)
Add a Resource Update Constraint.
|
default void |
deployWithStackSets(IProduct product,
StackSetsConstraintOptions options)
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 java.lang.String |
getPortfolioArn()
The ARN of the portfolio.
|
default java.lang.String |
getPortfolioId()
The ID of the portfolio.
|
default Stack |
getStack()
The stack in which this resource is defined.
|
default void |
giveAccessToGroup(IGroup group)
Associate portfolio with an IAM Group.
|
default void |
giveAccessToRole(IRole role)
Associate portfolio with an IAM Role.
|
default void |
giveAccessToUser(IUser user)
Associate portfolio with an IAM User.
|
default void |
notifyOnStackEvents(IProduct product,
ITopic topic,
CommonConstraintOptions options)
Add notifications for supplied topics on the provisioned product.
|
default void |
setLaunchRole(IProduct product,
IRole launchRole,
CommonConstraintOptions options)
Force users to assume a certain role when launching a product.
|
default void |
setLocalLaunchRole(IProduct product,
IRole launchRole,
CommonConstraintOptions options)
Force users to assume a certain role when launching a product.
|
default IRole |
setLocalLaunchRoleName(IProduct product,
java.lang.String launchRoleName,
CommonConstraintOptions options)
Force users to assume a certain role when launching a product.
|
default void |
shareWithAccount(java.lang.String accountId,
PortfolioShareOptions options)
Initiate a portfolio share with another account.
|
constrainTagUpdates, notifyOnStackEvents, setLaunchRole, setLocalLaunchRole, setLocalLaunchRoleName, shareWithAccount
default ConstructNode getNode()
getNode
in interface IConstruct
getNode
in interface IConstruct.Jsii$Default
getNode
in interface IResource.Jsii$Default
default 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
default Stack getStack()
getStack
in interface IResource
getStack
in interface IResource.Jsii$Default
default java.lang.String getPortfolioArn()
getPortfolioArn
in interface IPortfolio
default java.lang.String getPortfolioId()
getPortfolioId
in interface IPortfolio
default 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
policy
- This parameter is required.default void addProduct(IProduct product)
addProduct
in interface IPortfolio
product
- A service catalog produt. This parameter is required.default 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
tagOptions
- This parameter is required.default void constrainCloudFormationParameters(IProduct product, CloudFormationRuleConstraintOptions options)
constrainCloudFormationParameters
in interface IPortfolio
product
- A service catalog product. This parameter is required.options
- options for the constraint. This parameter is required.default void constrainTagUpdates(IProduct product, TagUpdateConstraintOptions options)
constrainTagUpdates
in interface IPortfolio
product
- This parameter is required.options
- default void deployWithStackSets(IProduct product, StackSetsConstraintOptions options)
deployWithStackSets
in interface IPortfolio
product
- A service catalog product. This parameter is required.options
- Configuration options for the constraint. This parameter is required.default void giveAccessToGroup(IGroup group)
giveAccessToGroup
in interface IPortfolio
group
- an IAM Group. This parameter is required.default void giveAccessToRole(IRole role)
giveAccessToRole
in interface IPortfolio
role
- an IAM role. This parameter is required.default void giveAccessToUser(IUser user)
giveAccessToUser
in interface IPortfolio
user
- an IAM user. This parameter is required.default void notifyOnStackEvents(IProduct product, ITopic topic, CommonConstraintOptions options)
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.options
- default 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
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.default 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
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.default 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
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.default void shareWithAccount(java.lang.String accountId, PortfolioShareOptions options)
shareWithAccount
in interface IPortfolio
accountId
- AWS account to share portfolio with. This parameter is required.options
- Options for the initiate share.