CfnProjectPropsMixin

class aws_cdk.mixins_preview.aws_sagemaker.mixins.CfnProjectPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-project.html
CloudformationResource:: AWS::SageMaker::Project
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_sagemaker import mixins as sagemaker_mixins

# service_catalog_provisioning_details: Any

cfn_project_props_mixin = sagemaker_mixins.CfnProjectPropsMixin(sagemaker_mixins.CfnProjectMixinProps(
    project_description="projectDescription",
    project_name="projectName",
    service_catalog_provisioned_product_details=sagemaker_mixins.CfnProjectPropsMixin.ServiceCatalogProvisionedProductDetailsProperty(
        provisioned_product_id="provisionedProductId",
        provisioned_product_status_message="provisionedProductStatusMessage"
    ),
    service_catalog_provisioning_details=service_catalog_provisioning_details,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    template_provider_details=[sagemaker_mixins.CfnProjectPropsMixin.TemplateProviderDetailProperty(
        cfn_template_provider_detail=sagemaker_mixins.CfnProjectPropsMixin.CfnTemplateProviderDetailProperty(
            parameters=[sagemaker_mixins.CfnProjectPropsMixin.CfnStackParameterProperty(
                key="key",
                value="value"
            )],
            role_arn="roleArn",
            template_name="templateName",
            template_url="templateUrl"
        )
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::SageMaker::Project.

Parameters:

props (Union[CfnProjectMixinProps, 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 = ['projectDescription', 'projectName', 'serviceCatalogProvisionedProductDetails', 'serviceCatalogProvisioningDetails', 'tags', 'templateProviderDetails']

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

CfnStackParameterProperty

class CfnProjectPropsMixin.CfnStackParameterProperty(*, key=None, value=None)

Bases: object

A key-value pair representing a parameter used in the CloudFormation stack.

Parameters:

key (Optional[str]) – The name of the CloudFormation parameter.
value (Optional[str]) – The value of the CloudFormation parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-cfnstackparameter.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_sagemaker import mixins as sagemaker_mixins

cfn_stack_parameter_property = sagemaker_mixins.CfnProjectPropsMixin.CfnStackParameterProperty(
    key="key",
    value="value"
)

Attributes

key

The name of the CloudFormation parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-cfnstackparameter.html#cfn-sagemaker-project-cfnstackparameter-key

value

The value of the CloudFormation parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-cfnstackparameter.html#cfn-sagemaker-project-cfnstackparameter-value

CfnTemplateProviderDetailProperty

class CfnProjectPropsMixin.CfnTemplateProviderDetailProperty(*, parameters=None, role_arn=None, template_name=None, template_url=None)

Bases: object

Details about a CloudFormation template provider configuration and associated provisioning information.

Parameters:

parameters (Union[IResolvable, Sequence[Union[IResolvable, CfnStackParameterProperty, Dict[str, Any]]], None]) – An array of CloudFormation stack parameters.
role_arn (Optional[str]) – The IAM role used by CloudFormation to create the stack.
template_name (Optional[str]) – The unique identifier of the template within the project.
template_url (Optional[str]) – The Amazon S3 URL of the CloudFormation template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-cfntemplateproviderdetail.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_sagemaker import mixins as sagemaker_mixins

cfn_template_provider_detail_property = sagemaker_mixins.CfnProjectPropsMixin.CfnTemplateProviderDetailProperty(
    parameters=[sagemaker_mixins.CfnProjectPropsMixin.CfnStackParameterProperty(
        key="key",
        value="value"
    )],
    role_arn="roleArn",
    template_name="templateName",
    template_url="templateUrl"
)

Attributes

parameters

An array of CloudFormation stack parameters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-cfntemplateproviderdetail.html#cfn-sagemaker-project-cfntemplateproviderdetail-parameters

role_arn

The IAM role used by CloudFormation to create the stack.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-cfntemplateproviderdetail.html#cfn-sagemaker-project-cfntemplateproviderdetail-rolearn

template_name

The unique identifier of the template within the project.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-cfntemplateproviderdetail.html#cfn-sagemaker-project-cfntemplateproviderdetail-templatename

template_url

The Amazon S3 URL of the CloudFormation template.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-cfntemplateproviderdetail.html#cfn-sagemaker-project-cfntemplateproviderdetail-templateurl

ProvisioningParameterProperty

class CfnProjectPropsMixin.ProvisioningParameterProperty(*, key=None, value=None)

Bases: object

A key value pair used when you provision a project as a service catalog product.

For information, see What is AWS Service Catalog .

Parameters:

key (Optional[str]) – The key that identifies a provisioning parameter.
value (Optional[str]) – The value of the provisioning parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-provisioningparameter.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_sagemaker import mixins as sagemaker_mixins

provisioning_parameter_property = sagemaker_mixins.CfnProjectPropsMixin.ProvisioningParameterProperty(
    key="key",
    value="value"
)

Attributes

key

The key that identifies a provisioning parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-provisioningparameter.html#cfn-sagemaker-project-provisioningparameter-key

value

The value of the provisioning parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-provisioningparameter.html#cfn-sagemaker-project-provisioningparameter-value

ServiceCatalogProvisionedProductDetailsProperty

class CfnProjectPropsMixin.ServiceCatalogProvisionedProductDetailsProperty(*, provisioned_product_id=None, provisioned_product_status_message=None)

Bases: object

Details of a provisioned service catalog product.

For information about service catalog, see What is AWS Service Catalog .

Parameters:

provisioned_product_id (Optional[str]) – The ID of the provisioned product.
provisioned_product_status_message (Optional[str]) – The current status of the product. - AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed. - UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations. - TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version. - ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack. - PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-servicecatalogprovisionedproductdetails.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_sagemaker import mixins as sagemaker_mixins

service_catalog_provisioned_product_details_property = sagemaker_mixins.CfnProjectPropsMixin.ServiceCatalogProvisionedProductDetailsProperty(
    provisioned_product_id="provisionedProductId",
    provisioned_product_status_message="provisionedProductStatusMessage"
)

Attributes

provisioned_product_id

The ID of the provisioned product.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-servicecatalogprovisionedproductdetails.html#cfn-sagemaker-project-servicecatalogprovisionedproductdetails-provisionedproductid

provisioned_product_status_message

The current status of the product.

AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.
UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.
TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.
ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-servicecatalogprovisionedproductdetails.html#cfn-sagemaker-project-servicecatalogprovisionedproductdetails-provisionedproductstatusmessage

ServiceCatalogProvisioningDetailsProperty

class CfnProjectPropsMixin.ServiceCatalogProvisioningDetailsProperty(*, path_id=None, product_id=None, provisioning_artifact_id=None, provisioning_parameters=None)

Bases: object

Details that you specify to provision a service catalog product.

For information about service catalog, see What is AWS Service Catalog .

Parameters:

path_id (Optional[str]) – The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.
product_id (Optional[str]) – The ID of the product to provision.
provisioning_artifact_id (Optional[str]) – The ID of the provisioning artifact.
provisioning_parameters (Union[IResolvable, Sequence[Union[IResolvable, ProvisioningParameterProperty, Dict[str, Any]]], None]) – A list of key value pairs that you specify when you provision a product.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-servicecatalogprovisioningdetails.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_sagemaker import mixins as sagemaker_mixins

service_catalog_provisioning_details_property = sagemaker_mixins.CfnProjectPropsMixin.ServiceCatalogProvisioningDetailsProperty(
    path_id="pathId",
    product_id="productId",
    provisioning_artifact_id="provisioningArtifactId",
    provisioning_parameters=[sagemaker_mixins.CfnProjectPropsMixin.ProvisioningParameterProperty(
        key="key",
        value="value"
    )]
)

Attributes

path_id

The path identifier of the product.

This value is optional if the product has a default path, and required if the product has more than one path.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-servicecatalogprovisioningdetails.html#cfn-sagemaker-project-servicecatalogprovisioningdetails-pathid

product_id

The ID of the product to provision.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-servicecatalogprovisioningdetails.html#cfn-sagemaker-project-servicecatalogprovisioningdetails-productid

provisioning_artifact_id

The ID of the provisioning artifact.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-servicecatalogprovisioningdetails.html#cfn-sagemaker-project-servicecatalogprovisioningdetails-provisioningartifactid

provisioning_parameters

A list of key value pairs that you specify when you provision a product.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-servicecatalogprovisioningdetails.html#cfn-sagemaker-project-servicecatalogprovisioningdetails-provisioningparameters

TemplateProviderDetailProperty

class CfnProjectPropsMixin.TemplateProviderDetailProperty(*, cfn_template_provider_detail=None)

Bases: object

Details about a template provider configuration and associated provisioning information.

Parameters:: cfn_template_provider_detail (Union[IResolvable, CfnTemplateProviderDetailProperty, Dict[str, Any], None]) – Details about a CloudFormation template provider configuration and associated provisioning information.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-templateproviderdetail.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_sagemaker import mixins as sagemaker_mixins

template_provider_detail_property = sagemaker_mixins.CfnProjectPropsMixin.TemplateProviderDetailProperty(
    cfn_template_provider_detail=sagemaker_mixins.CfnProjectPropsMixin.CfnTemplateProviderDetailProperty(
        parameters=[sagemaker_mixins.CfnProjectPropsMixin.CfnStackParameterProperty(
            key="key",
            value="value"
        )],
        role_arn="roleArn",
        template_name="templateName",
        template_url="templateUrl"
    )
)

Attributes

cfn_template_provider_detail

Details about a CloudFormation template provider configuration and associated provisioning information.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-project-templateproviderdetail.html#cfn-sagemaker-project-templateproviderdetail-cfntemplateproviderdetail