class Product

Language	Type name
.NET	Amazon.CDK.AWS.Servicecatalog.Product
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsservicecatalog#Product
Java	software.amazon.awscdk.services.servicecatalog.Product
Python	aws_cdk.aws_servicecatalog.Product
TypeScript (source)	aws-cdk-lib » aws_servicecatalog » Product

Implements IConstruct, IDependable, IResource, IProduct

Extends Resource

Implemented by CloudFormationProduct

Abstract class for Service Catalog Product.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_servicecatalog as servicecatalog } from 'aws-cdk-lib';
const product = servicecatalog.Product.fromProductArn(this, 'MyProduct', 'productArn');

Initializer

new Product(scope: Construct, id: string, props?: ResourceProps)

Parameters

• scope Construct
• id string
• props ResourceProps

Properties

Name	Type	Description
assetBuckets	IBucket[]	The asset buckets of a product created via product stack.
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
productArn	string	The ARN of the product.
productId	string	The id of the product.
stack	Stack	The stack in which this resource is defined.

---

assetBuckets

Type: IBucket[]

The asset buckets of a product created via product stack.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

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.

---

node

Type: Node

The tree node.

---

productArn

Type: string

The ARN of the product.

---

productId

Type: string

The id of the product.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
associateTagOptions(tagOptions)	Associate Tag Options.
toString()	Returns a string representation of this construct.
static fromProductArn(scope, id, productArn)	Creates a Product construct that represents an external product.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

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)

public associateTagOptions(tagOptions: TagOptions): void

Parameters

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

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromProductArn(scope, id, productArn)

public static fromProductArn(scope: Construct, id: string, productArn: string): IProduct

Parameters

• scope Construct — The parent creating construct (usually this).
• id string — The construct's name.
• productArn string — Product Arn.

Returns

• IProduct

Creates a Product construct that represents an external product.