CfnCloudFormationProductProps

class aws_cdk.aws_servicecatalog.CfnCloudFormationProductProps(*, name, owner, accept_language=None, description=None, distributor=None, product_type=None, provisioning_artifact_parameters=None, replace_provisioning_artifacts=None, source_connection=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.

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

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

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

  • product_type (Optional[str]) – The type of product.

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

  • 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.

  • source_connection (Union[IResolvable, SourceConnectionProperty, Dict[str, Any], None]) – A top level ProductViewDetail response containing details about the product’s connection. AWS Service Catalog returns this field for the CreateProduct , UpdateProduct , DescribeProductAsAdmin , and SearchProductAsAdmin APIs. This response contains the same fields as the ConnectionParameters request, with the addition of the LastSync response.

  • 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.

See:

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.
from aws_cdk import aws_servicecatalog as servicecatalog

# info: Any

cfn_cloud_formation_product_props = servicecatalog.CfnCloudFormationProductProps(
    name="name",
    owner="owner",

    # the properties below are optional
    accept_language="acceptLanguage",
    description="description",
    distributor="distributor",
    product_type="productType",
    provisioning_artifact_parameters=[servicecatalog.CfnCloudFormationProduct.ProvisioningArtifactPropertiesProperty(
        info=info,

        # the properties below are optional
        description="description",
        disable_template_validation=False,
        name="name",
        type="type"
    )],
    replace_provisioning_artifacts=False,
    source_connection=servicecatalog.CfnCloudFormationProduct.SourceConnectionProperty(
        connection_parameters=servicecatalog.CfnCloudFormationProduct.ConnectionParametersProperty(
            code_star=servicecatalog.CfnCloudFormationProduct.CodeStarParametersProperty(
                artifact_path="artifactPath",
                branch="branch",
                connection_arn="connectionArn",
                repository="repository"
            )
        ),
        type="type"
    ),
    support_description="supportDescription",
    support_email="supportEmail",
    support_url="supportUrl",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

accept_language

The language code.

  • jp - Japanese

  • zh - Chinese

See:

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

description

The description of the product.

See:

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

distributor

The distributor of the product.

See:

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

name

The name of the product.

See:

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

owner

The owner of the product.

See:

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

product_type

The type of product.

See:

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

provisioning_artifact_parameters

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

See:

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

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.

See:

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

source_connection

A top level ProductViewDetail response containing details about the product’s connection.

AWS Service Catalog returns this field for the CreateProduct , UpdateProduct , DescribeProductAsAdmin , and SearchProductAsAdmin APIs. This response contains the same fields as the ConnectionParameters request, with the addition of the LastSync response.

See:

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

support_description

The support information about the product.

See:

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

support_email

The contact email for product support.

See:

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

support_url

The contact URL for product support.

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

See:

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

tags

One or more tags.

See:

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