CfnCloudFormationProductProps

class aws_cdk.aws_servicecatalog.CfnCloudFormationProductProps(*, name, owner, provisioning_artifact_parameters, accept_language=None, description=None, distributor=None, replace_provisioning_artifacts=None, support_description=None, support_email=None, support_url=None, tags=None)

Bases: object

Properties for defining a CfnCloudFormationProduct.

Parameters
  • name (str) – The name of the product.

  • owner (str) – The owner of the product.

  • provisioning_artifact_parameters (Union[IResolvable, Sequence[Union[IResolvable, ProvisioningArtifactPropertiesProperty, Dict[str, Any]]]]) – The configuration of the provisioning artifact (also known as a version).

  • accept_language (Optional[str]) – The language code. - en - English (default) - jp - Japanese - zh - Chinese

  • description (Optional[str]) – The description of the product.

  • distributor (Optional[str]) – The distributor of the product.

  • replace_provisioning_artifacts (Union[bool, IResolvable, None]) – This property is turned off by default. If turned off, you can update provisioning artifacts or product attributes (such as description, distributor, name, owner, and more) and the associated provisioning artifacts will retain the same unique identifier. Provisioning artifacts are matched within the CloudFormationProduct resource, and only those that have been updated will be changed. Provisioning artifacts are matched by a combinaton of provisioning artifact template URL and name. If turned on, provisioning artifacts will be given a new unique identifier when you update the product or provisioning artifacts.

  • support_description (Optional[str]) – The support information about the product.

  • support_email (Optional[str]) – The contact email for product support.

  • support_url (Optional[str]) – The contact URL for product support. ^https?:\/\// / is the pattern used to validate SupportUrl.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – One or more tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_servicecatalog as servicecatalog

# info: Any

cfn_cloud_formation_product_props = servicecatalog.CfnCloudFormationProductProps(
    name="name",
    owner="owner",
    provisioning_artifact_parameters=[servicecatalog.CfnCloudFormationProduct.ProvisioningArtifactPropertiesProperty(
        info=info,

        # the properties below are optional
        description="description",
        disable_template_validation=False,
        name="name"
    )],

    # the properties below are optional
    accept_language="acceptLanguage",
    description="description",
    distributor="distributor",
    replace_provisioning_artifacts=False,
    support_description="supportDescription",
    support_email="supportEmail",
    support_url="supportUrl",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

accept_language

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-acceptlanguage

Return type

Optional[str]

description

The description of the product.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-description

Return type

Optional[str]

distributor

The distributor of the product.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-distributor

Return type

Optional[str]

name

The name of the product.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-name

Return type

str

owner

The owner of the product.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-owner

Return type

str

provisioning_artifact_parameters

The configuration of the provisioning artifact (also known as a version).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-provisioningartifactparameters

Return type

Union[IResolvable, List[Union[IResolvable, ProvisioningArtifactPropertiesProperty]]]

replace_provisioning_artifacts

This property is turned off by default.

If turned off, you can update provisioning artifacts or product attributes (such as description, distributor, name, owner, and more) and the associated provisioning artifacts will retain the same unique identifier. Provisioning artifacts are matched within the CloudFormationProduct resource, and only those that have been updated will be changed. Provisioning artifacts are matched by a combinaton of provisioning artifact template URL and name.

If turned on, provisioning artifacts will be given a new unique identifier when you update the product or provisioning artifacts.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-replaceprovisioningartifacts

Return type

Union[bool, IResolvable, None]

support_description

The support information about the product.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-supportdescription

Return type

Optional[str]

support_email

The contact email for product support.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-supportemail

Return type

Optional[str]

support_url

The contact URL for product support.

^https?:\/\// / is the pattern used to validate SupportUrl.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-supporturl

Return type

Optional[str]

tags

One or more tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-tags

Return type

Optional[List[CfnTag]]