IPortfolio Interface
A Service Catalog portfolio.
Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#The environment this resource belongs to.
notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
The ARN of the portfolio.
The ID of the portfolio.
portfolioRefPortfolioReferenceportfolio_refPortfolioReferenceportfolioRefPortfolioReferencePortfolioRefPortfolioReferencePortfolioRefPortfolioReference#A reference to a Portfolio resource.
Methods
addProduct(product: IProduct): voiddef add_product(self, product: IProduct) -> Nonepublic void addProduct(IProduct product)public void AddProduct(IProduct product)func AddProduct(Product IProduct)#Associate portfolio with the given product.
1 parameter
Parameters
productproductproductproductProduct— A service catalog produt.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#Apply the given removal policy to this resource.
notes
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).
associateTagOptions(tagOptions: TagOptions): voiddef associate_tag_options(self, tag_options: TagOptions) -> Nonepublic void associateTagOptions(TagOptions tagOptions)public void AssociateTagOptions(TagOptions tagOptions)func 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.
constrainCloudFormationParameters(product: IProduct, options: CloudFormationRuleConstraintOptions): voiddef constrain_cloud_formation_parameters(self, product: IProduct, options: CloudFormationRuleConstraintOptions) -> Nonepublic void constrainCloudFormationParameters(IProduct product, CloudFormationRuleConstraintOptions options)public void ConstrainCloudFormationParameters(IProduct product, CloudFormationRuleConstraintOptions options)func ConstrainCloudFormationParameters(Product IProduct, Options CloudFormationRuleConstraintOptions)#Set provisioning rules for the product.
2 parameters
Parameters
productproductproductproductProduct— A service catalog product.optionsoptionsoptionsoptionsOptions— options for the constraint.
constrainTagUpdates(product: IProduct, options?: TagUpdateConstraintOptions): voiddef constrain_tag_updates(self, product: IProduct, options: typing.Optional[TagUpdateConstraintOptions] = None) -> Nonepublic void constrainTagUpdates(IProduct product, TagUpdateConstraintOptions options)public void ConstrainTagUpdates(IProduct product, TagUpdateConstraintOptions? options = null)func ConstrainTagUpdates(Product IProduct, Options TagUpdateConstraintOptions)#Add a Resource Update Constraint.
deployWithStackSets(product: IProduct, options: StackSetsConstraintOptions): voiddef deploy_with_stack_sets(self, product: IProduct, options: StackSetsConstraintOptions) -> Nonepublic void deployWithStackSets(IProduct product, StackSetsConstraintOptions options)public void DeployWithStackSets(IProduct product, StackSetsConstraintOptions options)func DeployWithStackSets(Product IProduct, Options StackSetsConstraintOptions)#Configure deployment options using AWS Cloudformation StackSets.
2 parameters
Parameters
productproductproductproductProduct— A service catalog product.optionsoptionsoptionsoptionsOptions— Configuration options for the constraint.
giveAccessToGroup(group: IGroup): voiddef give_access_to_group(self, group: IGroup) -> Nonepublic void giveAccessToGroup(IGroup group)public void GiveAccessToGroup(IGroup group)func GiveAccessToGroup(Group IGroup)#Associate portfolio with an IAM Group.
1 parameter
Parameters
groupgroupgroupgroupGroup— an IAM Group.
giveAccessToRole(role: IRole): voiddef give_access_to_role(self, role: IRole) -> Nonepublic void giveAccessToRole(IRole role)public void GiveAccessToRole(IRole role)func GiveAccessToRole(Role IRole)#Associate portfolio with an IAM Role.
1 parameter
Parameters
roleroleroleroleRole— an IAM role.
giveAccessToUser(user: IUser): voiddef give_access_to_user(self, user: IUser) -> Nonepublic void giveAccessToUser(IUser user)public void GiveAccessToUser(IUser user)func GiveAccessToUser(User IUser)#Associate portfolio with an IAM User.
1 parameter
Parameters
useruseruseruserUser— an IAM user.
notifyOnStackEvents(product: IProduct, topic: ITopic, options?: CommonConstraintOptions): voiddef notify_on_stack_events(self, product: IProduct, topic: ITopic, options: typing.Optional[CommonConstraintOptions] = None) -> Nonepublic void notifyOnStackEvents(IProduct product, ITopic topic, CommonConstraintOptions options)public void NotifyOnStackEvents(IProduct product, ITopic topic, CommonConstraintOptions? options = null)func NotifyOnStackEvents(Product IProduct, Topic ITopic, Options CommonConstraintOptions)#Add notifications for supplied topics on the provisioned product.
2 parameters
Parameters
productproductproductproductProduct— A service catalog product.topictopictopictopicTopic— A SNS Topic to receive notifications on events related to the provisioned product.
setLaunchRole(product: IProduct, launchRole: IRole, options?: CommonConstraintOptions): voiddef set_launch_role(self, product: IProduct, launch_role: IRole, options: typing.Optional[CommonConstraintOptions] = None) -> Nonepublic void setLaunchRole(IProduct product, IRole launchRole, CommonConstraintOptions options)public void SetLaunchRole(IProduct product, IRole launchRole, CommonConstraintOptions? options = null)func SetLaunchRole(Product IProduct, LaunchRole IRole, Options CommonConstraintOptions)#Force users to assume a certain role when launching a product.
notes · 3 parameters
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.
Parameters
productproductproductproductProduct— A service catalog product.launchRolelaunch_rolelaunchRolelaunchRoleLaunchRole— The IAM role a user must assume when provisioning the product.optionsoptionsoptionsoptionsOptions— options for the constraint.
setLocalLaunchRole(product: IProduct, launchRole: IRole, options?: CommonConstraintOptions): voiddef set_local_launch_role(self, product: IProduct, launch_role: IRole, options: typing.Optional[CommonConstraintOptions] = None) -> Nonepublic void setLocalLaunchRole(IProduct product, IRole launchRole, CommonConstraintOptions options)public void SetLocalLaunchRole(IProduct product, IRole launchRole, CommonConstraintOptions? options = null)func SetLocalLaunchRole(Product IProduct, LaunchRole IRole, Options CommonConstraintOptions)#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.
3 parameters
Parameters
productproductproductproductProduct— A service catalog product.launchRolelaunch_rolelaunchRolelaunchRoleLaunchRole— The IAM role a user must assume when provisioning the product.optionsoptionsoptionsoptionsOptions— options for the constraint.
setLocalLaunchRoleName(product: IProduct, launchRoleName: string, options?: CommonConstraintOptions): IRoledef set_local_launch_role_name(self, product: IProduct, launch_role_name: str, options: typing.Optional[CommonConstraintOptions] = None) -> IRolepublic IRole setLocalLaunchRoleName(IProduct product, String launchRoleName, CommonConstraintOptions options)public IRole SetLocalLaunchRoleName(IProduct product, string launchRoleName, CommonConstraintOptions? options = null)func SetLocalLaunchRoleName(Product IProduct, LaunchRoleName *string, Options CommonConstraintOptions) IRole#Force users to assume a certain role when launching a product.
notes · 3 parameters
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.
Parameters
productproductproductproductProduct— A service catalog product.launchRoleNamelaunch_role_namelaunchRoleNamelaunchRoleNameLaunchRoleName— The name of the IAM role a user must assume when provisioning the product.optionsoptionsoptionsoptionsOptions— options for the constraint.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.
1 parameter · returns
Parameters
mixinsmixinsmixinsmixinsMixins— The mixins to apply.
Returns: This construct for chaining