# Portfolio

A Service Catalog portfolio.

Extends: Construct › Resource › Portfolio
Implements: IResource, IPortfolio, IEnvironmentAware, IPortfolioRef, IConstruct, IDependable

- CloudFormation: [`AWS::ServiceCatalog::Portfolio`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-servicecatalog-portfolio.html)
- L1 type: [`CfnPortfolio`](/cdk/api/v2/docs/aws-cdk-lib.aws_servicecatalog.CfnPortfolio.html)
- 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#L319)
- Type last changed: v2.234.0 · 8 Jan 2026

## Example

```ts
new servicecatalog.Portfolio(this, 'Portfolio', {
  displayName: 'MyPortfolio',
  providerName: 'MyTeam',
});
```

## Initializer

```ts
new Portfolio(scope: Construct, id: string, props: PortfolioProps)
```

## Construct Props

- `description`: string — Description for portfolio.

  **Default:** No description provided

- `displayName`: string (required) — The name of the portfolio.

- `messageLanguage`: [MessageLanguage](/cdk/api/v2/docs/aws-cdk-lib.aws_servicecatalog.MessageLanguage.html) = English — The message language.

  Controls language for
  status logging and errors.

- `providerName`: string (required) — The provider name.

- `tagOptions`: [TagOptions](/cdk/api/v2/docs/aws-cdk-lib.aws_servicecatalog.TagOptions.html) — TagOptions associated directly to a portfolio.

  **Default:** No tagOptions provided

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

- `PROPERTY_INJECTION_ID`: string (static) — Uniquely identifies this class.

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

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

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

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

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

- `fromPortfolioArn(scope: Construct, id: string, portfolioArn: string): IPortfolio` (static) — Creates a Portfolio construct that represents an external portfolio.

  **Parameters**

  - `scope` — The parent creating construct (usually `this`).
  - `id` — The construct's name.
  - `portfolioArn` — the Amazon Resource Name of the existing portfolio.

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

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

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

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `notifyOnStackEvents(product: IProduct, topic: ITopic, options?: CommonConstraintOptions): void` — Add notifications for supplied topics on 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.

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

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

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

- `toString(): string` — Returns a string representation of this construct.

- `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.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.