CfnCloudFormationProductPropsMixin

class aws_cdk.mixins_preview.aws_servicecatalog.mixins.CfnCloudFormationProductPropsMixin(props, *, strategy=None)

Bases: Mixin

Specifies a product.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html
CloudformationResource:: AWS::ServiceCatalog::CloudFormationProduct
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_servicecatalog import mixins as servicecatalog_mixins

# info: Any

cfn_cloud_formation_product_props_mixin = servicecatalog_mixins.CfnCloudFormationProductPropsMixin(servicecatalog_mixins.CfnCloudFormationProductMixinProps(
    accept_language="acceptLanguage",
    description="description",
    distributor="distributor",
    name="name",
    owner="owner",
    product_type="productType",
    provisioning_artifact_parameters=[servicecatalog_mixins.CfnCloudFormationProductPropsMixin.ProvisioningArtifactPropertiesProperty(
        description="description",
        disable_template_validation=False,
        info=info,
        name="name",
        type="type"
    )],
    replace_provisioning_artifacts=False,
    source_connection=servicecatalog_mixins.CfnCloudFormationProductPropsMixin.SourceConnectionProperty(
        connection_parameters=servicecatalog_mixins.CfnCloudFormationProductPropsMixin.ConnectionParametersProperty(
            code_star=servicecatalog_mixins.CfnCloudFormationProductPropsMixin.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"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ServiceCatalog::CloudFormationProduct.

Parameters:

props (Union[CfnCloudFormationProductMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['acceptLanguage', 'description', 'distributor', 'name', 'owner', 'productType', 'provisioningArtifactParameters', 'replaceProvisioningArtifacts', 'sourceConnection', 'supportDescription', 'supportEmail', 'supportUrl', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

CodeStarParametersProperty

class CfnCloudFormationProductPropsMixin.CodeStarParametersProperty(*, artifact_path=None, branch=None, connection_arn=None, repository=None)

Bases: object

The subtype containing details about the Codestar connection Type .

Parameters:

artifact_path (Optional[str]) – The absolute path wehre the artifact resides within the repo and branch, formatted as “folder/file.json.”.
branch (Optional[str]) – The specific branch where the artifact resides.
connection_arn (Optional[str]) – The CodeStar ARN, which is the connection between AWS Service Catalog and the external repository.
repository (Optional[str]) – The specific repository where the product’s artifact-to-be-synced resides, formatted as “Account/Repo.”.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-codestarparameters.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.mixins_preview.aws_servicecatalog import mixins as servicecatalog_mixins

code_star_parameters_property = servicecatalog_mixins.CfnCloudFormationProductPropsMixin.CodeStarParametersProperty(
    artifact_path="artifactPath",
    branch="branch",
    connection_arn="connectionArn",
    repository="repository"
)

Attributes

artifact_path

The absolute path wehre the artifact resides within the repo and branch, formatted as “folder/file.json.”.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-codestarparameters.html#cfn-servicecatalog-cloudformationproduct-codestarparameters-artifactpath

branch

The specific branch where the artifact resides.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-codestarparameters.html#cfn-servicecatalog-cloudformationproduct-codestarparameters-branch

connection_arn

The CodeStar ARN, which is the connection between AWS Service Catalog and the external repository.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-codestarparameters.html#cfn-servicecatalog-cloudformationproduct-codestarparameters-connectionarn

repository

The specific repository where the product’s artifact-to-be-synced resides, formatted as “Account/Repo.”.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-codestarparameters.html#cfn-servicecatalog-cloudformationproduct-codestarparameters-repository

ConnectionParametersProperty

class CfnCloudFormationProductPropsMixin.ConnectionParametersProperty(*, code_star=None)

Bases: object

Provides connection details.

Parameters:: code_star (Union[IResolvable, CodeStarParametersProperty, Dict[str, Any], None]) – Provides ConnectionType details.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-connectionparameters.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.mixins_preview.aws_servicecatalog import mixins as servicecatalog_mixins

connection_parameters_property = servicecatalog_mixins.CfnCloudFormationProductPropsMixin.ConnectionParametersProperty(
    code_star=servicecatalog_mixins.CfnCloudFormationProductPropsMixin.CodeStarParametersProperty(
        artifact_path="artifactPath",
        branch="branch",
        connection_arn="connectionArn",
        repository="repository"
    )
)

Attributes

code_star

Provides ConnectionType details.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-connectionparameters.html#cfn-servicecatalog-cloudformationproduct-connectionparameters-codestar

ProvisioningArtifactPropertiesProperty

class CfnCloudFormationProductPropsMixin.ProvisioningArtifactPropertiesProperty(*, description=None, disable_template_validation=None, info=None, name=None, type=None)

Bases: object

Information about a provisioning artifact (also known as a version) for a product.

Parameters:

description (Optional[str]) – The description of the provisioning artifact, including how it differs from the previous provisioning artifact.
disable_template_validation (Union[bool, IResolvable, None]) – If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.
info (Any) – Specify the template source with one of the following options, but not both. Keys accepted: [ LoadTemplateFromURL , ImportFromPhysicalId ] The URL of the AWS CloudFormation template in Amazon S3 in JSON format. Specify the URL in JSON format as follows: "LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..." ImportFromPhysicalId : The physical id of the resource that contains the template. Currently only supports AWS CloudFormation stack arn. Specify the physical id in JSON format as follows: ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]
name (Optional[str]) – The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.
type (Optional[str]) – The type of provisioning artifact. - CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template - TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file - TERRAFORM_CLOUD - Terraform Cloud configuration file - EXTERNAL - External configuration file

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-provisioningartifactproperties.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.mixins_preview.aws_servicecatalog import mixins as servicecatalog_mixins

# info: Any

provisioning_artifact_properties_property = servicecatalog_mixins.CfnCloudFormationProductPropsMixin.ProvisioningArtifactPropertiesProperty(
    description="description",
    disable_template_validation=False,
    info=info,
    name="name",
    type="type"
)

Attributes

description

The description of the provisioning artifact, including how it differs from the previous provisioning artifact.

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

disable_template_validation

If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-provisioningartifactproperties.html#cfn-servicecatalog-cloudformationproduct-provisioningartifactproperties-disabletemplatevalidation

info

Specify the template source with one of the following options, but not both.

Keys accepted: [ LoadTemplateFromURL , ImportFromPhysicalId ]

The URL of the AWS CloudFormation template in Amazon S3 in JSON format. Specify the URL in JSON format as follows:

"LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."

ImportFromPhysicalId : The physical id of the resource that contains the template. Currently only supports AWS CloudFormation stack arn. Specify the physical id in JSON format as follows: ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-provisioningartifactproperties.html#cfn-servicecatalog-cloudformationproduct-provisioningartifactproperties-info

name

The name of the provisioning artifact (for example, v1 v2beta).

No spaces are allowed.

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

type

The type of provisioning artifact.

CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template
TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file
TERRAFORM_CLOUD - Terraform Cloud configuration file
EXTERNAL - External configuration file

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-provisioningartifactproperties.html#cfn-servicecatalog-cloudformationproduct-provisioningartifactproperties-type

SourceConnectionProperty

class CfnCloudFormationProductPropsMixin.SourceConnectionProperty(*, connection_parameters=None, type=None)

Bases: object

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.

Parameters:

connection_parameters (Union[IResolvable, ConnectionParametersProperty, Dict[str, Any], None]) – The connection details based on the connection Type .
type (Optional[str]) – The only supported SourceConnection type is Codestar.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicecatalog-cloudformationproduct-sourceconnection.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.mixins_preview.aws_servicecatalog import mixins as servicecatalog_mixins

source_connection_property = servicecatalog_mixins.CfnCloudFormationProductPropsMixin.SourceConnectionProperty(
    connection_parameters=servicecatalog_mixins.CfnCloudFormationProductPropsMixin.ConnectionParametersProperty(
        code_star=servicecatalog_mixins.CfnCloudFormationProductPropsMixin.CodeStarParametersProperty(
            artifact_path="artifactPath",
            branch="branch",
            connection_arn="connectionArn",
            repository="repository"
        )
    ),
    type="type"
)

Attributes

connection_parameters

The connection details based on the connection Type .

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

type

The only supported SourceConnection type is Codestar.

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