class CloudFormationProduct (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Servicecatalog.CloudFormationProduct |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsservicecatalog#CloudFormationProduct |
![]() | software.amazon.awscdk.services.servicecatalog.CloudFormationProduct |
![]() | aws_cdk.aws_servicecatalog.CloudFormationProduct |
![]() | 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
Cloud
Formation Product Props
Construct Props
Name | Type | Description |
---|---|---|
owner | string | The owner of the product. |
product | string | The name of the product. |
product | Cloud [] | The configuration of the product version. |
description? | string | The description of the product. |
distributor? | string | The distributor of the product. |
message | Message | The language code. |
replace | boolean | Whether to give provisioning artifacts a new unique identifier when the product attributes or provisioning artifacts is updated. |
support | string | The support information about the product. |
support | string | The contact email for product support. |
support | string | The contact URL for product support. |
tag | Tag | TagOptions associated directly to a product. |
owner
Type:
string
The owner of the product.
productName
Type:
string
The name of the product.
productVersions
Type:
Cloud
[]
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:
Message
(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:
Tag
(optional, default: No tagOptions provided)
TagOptions associated directly to a product.
Properties
Name | Type | Description |
---|---|---|
asset | IBucket [] | The asset bucket of a product created via product stack. |
env | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
product | string | The ARN of the product. |
product | string | The id of the product. |
stack | Stack | The stack in which this resource is defined. |
assetBuckets
Type:
IBucket
[]
The asset bucket of a product created via product stack.
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:
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 |
---|---|
apply | Apply the given removal policy to this resource. |
associate | Associate Tag Options. |
to | Returns a string representation of this construct. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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
Tag
Options
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.