interface IProduct
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.ServiceCatalog.IProduct |
 Java | software.amazon.awscdk.services.servicecatalog.IProduct |
 Python | aws_cdk.aws_servicecatalog.IProduct |
 TypeScript (source) | @aws-cdk/aws-servicecatalog » IProduct |
Implemented by
Cloud
Obtainable from
Product.fromProductArn()
A Service Catalog product, currently only supports type CloudFormationProduct.
Properties
| Name | Type | Description |
|---|---|---|
| env | Resource | The environment this resource belongs to. |
| node | Construct | The construct tree node for this construct. |
| product | string | The ARN of the product. |
| product | string | The id of the product. |
| stack | Stack | The stack in which this resource is defined. |
env
Type:
Resource
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:
Construct
The construct tree node for this construct.
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 |
|---|---|
| apply | Apply the given removal policy to this resource. |
| associate | Associate Tag Options. |
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.