CfnExperimentPropsMixin

class aws_cdk.cfn_property_mixins.aws_sagemaker.CfnExperimentPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource type definition for AWS::SageMaker::Experiment.

An experiment is a collection of related trials used to organize and track machine learning workflows.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-experiment.html

CloudformationResource:

AWS::SageMaker::Experiment

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.cfn_property_mixins import aws_sagemaker as sagemaker
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_experiment_props_mixin = sagemaker.CfnExperimentPropsMixin(sagemaker.CfnExperimentMixinProps(
    description="description",
    display_name="displayName",
    experiment_name="experimentName",
    tags=[sagemaker.CfnExperimentPropsMixin.TagsItemsProperty(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

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

Parameters:
  • props (Union[CfnExperimentMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

None

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'displayName', 'experimentName', 'tags']

Static Methods

classmethod is_mixin(x)

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.

TagsItemsProperty

class CfnExperimentPropsMixin.TagsItemsProperty(*, key=None, value=None)

Bases: object

Parameters:
  • key (Optional[str]) – The tag key.

  • value (Optional[str]) – The tag value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-experiment-tagsitems.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.cfn_property_mixins import aws_sagemaker as sagemaker

tags_items_property = sagemaker.CfnExperimentPropsMixin.TagsItemsProperty(
    key="key",
    value="value"
)

Attributes

key

The tag key.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-experiment-tagsitems.html#cfn-sagemaker-experiment-tagsitems-key

value

The tag value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-experiment-tagsitems.html#cfn-sagemaker-experiment-tagsitems-value