# IPortfolio

A Service Catalog portfolio.

Extends: IPortfolio
Extends: IResource, IPortfolioRef
Implemented by: Portfolio

- Source: [`aws-servicecatalog/lib/portfolio.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-servicecatalog/lib/portfolio.ts#L47)
- Type last changed: v2.234.0 · 8 Jan 2026

## Properties

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — The environment this resource belongs to.

  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.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `portfolioArn`: string — The ARN of the portfolio.

- `portfolioId`: string — The ID of the portfolio.

- `portfolioRef`: [PortfolioReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_servicecatalog.PortfolioReference.html) — A reference to a Portfolio resource.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this resource is defined.

## Methods

- `addProduct(product: IProduct): void` — Associate portfolio with the given product.

  **Parameters**

  - `product` — A service catalog produt.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — 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`).

- `associateTagOptions(tagOptions: TagOptions): void` — 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): void` — Set provisioning rules for the product.

  **Parameters**

  - `product` — A service catalog product.
  - `options` — options for the constraint.

- `constrainTagUpdates(product: IProduct, options?: TagUpdateConstraintOptions): void` — Add a Resource Update Constraint.

- `deployWithStackSets(product: IProduct, options: StackSetsConstraintOptions): void` — Configure deployment options using AWS Cloudformation StackSets.

  **Parameters**

  - `product` — A service catalog product.
  - `options` — Configuration options for the constraint.

- `giveAccessToGroup(group: IGroup): void` — Associate portfolio with an IAM Group.

  **Parameters**

  - `group` — an IAM Group.

- `giveAccessToRole(role: IRole): void` — Associate portfolio with an IAM Role.

  **Parameters**

  - `role` — an IAM role.

- `giveAccessToUser(user: IUser): void` — Associate portfolio with an IAM User.

  **Parameters**

  - `user` — an IAM user.

- `notifyOnStackEvents(product: IProduct, topic: ITopic, options?: CommonConstraintOptions): void` — Add notifications for supplied topics on the provisioned product.

  **Parameters**

  - `product` — A service catalog product.
  - `topic` — A SNS Topic to receive notifications on events related to the provisioned product.

- `setLaunchRole(product: IProduct, launchRole: IRole, options?: CommonConstraintOptions): void` — 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.

  **Parameters**

  - `product` — A service catalog product.
  - `launchRole` — The IAM role a user must assume when provisioning the product.
  - `options` — options for the constraint.

- `setLocalLaunchRole(product: IProduct, launchRole: IRole, options?: CommonConstraintOptions): void` — 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.

  **Parameters**

  - `product` — A service catalog product.
  - `launchRole` — The IAM role a user must assume when provisioning the product.
  - `options` — options for the constraint.

- `setLocalLaunchRoleName(product: IProduct, launchRoleName: string, options?: CommonConstraintOptions): IRole` — 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.

  **Parameters**

  - `product` — A service catalog product.
  - `launchRoleName` — The name of the IAM role a user must assume when provisioning the product.
  - `options` — options for the constraint.

- `shareWithAccount(accountId: string, options?: PortfolioShareOptions): void` — Initiate a portfolio share with another account.

  **Parameters**

  - `accountId` — AWS account to share portfolio with.
  - `options` — Options for the initiate share.

- `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.

  **Parameters**

  - `mixins` — The mixins to apply.

  **Returns:** This construct for chaining