aws-cdk-lib.aws_servicecatalog.CloudFormationProduct

class CloudFormationProduct (construct)

LanguageType name
.NETAmazon.CDK.AWS.Servicecatalog.CloudFormationProduct
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsservicecatalog#CloudFormationProduct
Javasoftware.amazon.awscdk.services.servicecatalog.CloudFormationProduct
Pythonaws_cdk.aws_servicecatalog.CloudFormationProduct
TypeScript (source)aws-cdk-lib » aws_servicecatalog » CloudFormationProduct

Implements IConstruct, IDependable, IResource, IProduct

A Service Catalog Cloudformation Product.

Example

import * as cdk from 'aws-cdk-lib';

class S3BucketProduct extends servicecatalog.ProductStack {
  constructor(scope: Construct, id: string) {
    super(scope, id);

    new s3.Bucket(this, 'BucketProduct');
  }
}

const product = new servicecatalog.CloudFormationProduct(this, 'Product', {
  productName: "My Product",
  owner: "Product Owner",
  productVersions: [
    {
      productVersionName: "v1",
      cloudFormationTemplate: servicecatalog.CloudFormationTemplate.fromProductStack(new S3BucketProduct(this, 'S3BucketProduct')),
    },
  ],
});

Initializer

new CloudFormationProduct(scope: Construct, id: string, props: CloudFormationProductProps)

Parameters

  • scope Construct
  • id string
  • props CloudFormationProductProps

Construct Props

NameTypeDescription
ownerstringThe owner of the product.
productNamestringThe name of the product.
productVersionsCloudFormationProductVersion[]The configuration of the product version.
description?stringThe description of the product.
distributor?stringThe distributor of the product.
messageLanguage?MessageLanguageThe language code.
replaceProductVersionIds?booleanWhether to give provisioning artifacts a new unique identifier when the product attributes or provisioning artifacts is updated.
supportDescription?stringThe support information about the product.
supportEmail?stringThe contact email for product support.
supportUrl?stringThe contact URL for product support.
tagOptions?TagOptionsTagOptions associated directly to a product.

owner

Type: string

The owner of the product.


productName

Type: string

The name of the product.


productVersions

Type: CloudFormationProductVersion[]

The configuration of the product version.


description?

Type: string (optional, default: No description provided)

The description of the product.


distributor?

Type: string (optional, default: No distributor provided)

The distributor of the product.


messageLanguage?

Type: MessageLanguage (optional, default: English)

The language code.

Controls language for logging and errors.


replaceProductVersionIds?

Type: boolean (optional, default: false)

Whether to give provisioning artifacts a new unique identifier when the product attributes or provisioning artifacts is updated.


supportDescription?

Type: string (optional, default: No support description provided)

The support information about the product.


supportEmail?

Type: string (optional, default: No support email provided)

The contact email for product support.


supportUrl?

Type: string (optional, default: No support URL provided)

The contact URL for product support.


tagOptions?

Type: TagOptions (optional, default: No tagOptions provided)

TagOptions associated directly to a product.

Properties

NameTypeDescription
assetBucketsIBucket[]The asset bucket of a product created via product stack.
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
productArnstringThe ARN of the product.
productIdstringThe id of the product.
stackStackThe stack in which this resource is defined.

assetBuckets

Type: IBucket[]

The asset bucket 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

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
associateTagOptions(tagOptions)Associate Tag Options.
toString()Returns a string representation of this construct.

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.