CloudFormationProduct

class aws_cdk.aws_servicecatalog.CloudFormationProduct(scope, id, *, owner, product_name, product_versions, description=None, distributor=None, message_language=None, replace_product_version_ids=None, support_description=None, support_email=None, support_url=None, tag_options=None)

Bases: Product

A Service Catalog Cloudformation Product.

ExampleMetadata:: infused

Example:

import aws_cdk as cdk


class S3BucketProduct(servicecatalog.ProductStack):
    def __init__(self, scope, id):
        super().__init__(scope, id)

        s3.Bucket(self, "BucketProduct")

product = servicecatalog.CloudFormationProduct(self, "Product",
    product_name="My Product",
    owner="Product Owner",
    product_versions=[servicecatalog.CloudFormationProductVersion(
        product_version_name="v1",
        cloud_formation_template=servicecatalog.CloudFormationTemplate.from_product_stack(S3BucketProduct(self, "S3BucketProduct"))
    )
    ]
)

Parameters:

scope (Construct) –
id (str) –
owner (str) – The owner of the product.
product_name (str) – The name of the product.
product_versions (Sequence[Union[CloudFormationProductVersion, Dict[str, Any]]]) – The configuration of the product version.
description (Optional[str]) – The description of the product. Default: - No description provided
distributor (Optional[str]) – The distributor of the product. Default: - No distributor provided
message_language (Optional[MessageLanguage]) – The language code. Controls language for logging and errors. Default: - English
replace_product_version_ids (Optional[bool]) – Whether to give provisioning artifacts a new unique identifier when the product attributes or provisioning artifacts is updated. Default: false
support_description (Optional[str]) – The support information about the product. Default: - No support description provided
support_email (Optional[str]) – The contact email for product support. Default: - No support email provided
support_url (Optional[str]) – The contact URL for product support. Default: - No support URL provided
tag_options (Optional[TagOptions]) – TagOptions associated directly to a product. Default: - No tagOptions provided

Methods

apply_removal_policy(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).

Parameters:

policy (RemovalPolicy) –

Return type:

None

associate_tag_options(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.

Parameters:

tag_options (TagOptions) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

asset_buckets

The asset bucket of a product created via product stack.

Default:

Empty - no assets are used in this product

env

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: The tree node.

product_arn: The ARN of the product.

product_id: The id of the product.

stack: The stack in which this resource is defined.

Static Methods

classmethod from_product_arn(scope, id, product_arn)

Creates a Product construct that represents an external product.

Parameters:

scope (Construct) – The parent creating construct (usually this).
id (str) – The construct’s name.
product_arn (str) – Product Arn.

Return type:

IProduct

classmethod is_construct(x)

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) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool