CfnExperimentTrialComponentPropsMixin

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

Bases: Mixin

Resource type definition for AWS SageMaker Experiment Trial Component.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-experimenttrialcomponent.html
CloudformationResource:: AWS::SageMaker::ExperimentTrialComponent
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_trial_component_props_mixin = sagemaker.CfnExperimentTrialComponentPropsMixin(sagemaker.CfnExperimentTrialComponentMixinProps(
    display_name="displayName",
    end_time="endTime",
    metadata_properties=sagemaker.CfnExperimentTrialComponentPropsMixin.MetadataPropertiesProperty(
        commit_id="commitId",
        generated_by="generatedBy",
        project_id="projectId",
        repository="repository"
    ),
    start_time="startTime",
    status=sagemaker.CfnExperimentTrialComponentPropsMixin.StatusProperty(
        message="message",
        primary_status="primaryStatus"
    ),
    tags=[sagemaker.CfnExperimentTrialComponentPropsMixin.TagsItemsProperty(
        key="key",
        value="value"
    )],
    trial_component_name="trialComponentName"
),
    strategy=merge_strategy
)

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

Parameters:

props (Union[CfnExperimentTrialComponentMixinProps, 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 = ['displayName', 'endTime', 'metadataProperties', 'startTime', 'status', 'tags', 'trialComponentName']

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.

MetadataPropertiesProperty

class CfnExperimentTrialComponentPropsMixin.MetadataPropertiesProperty(*, commit_id=None, generated_by=None, project_id=None, repository=None)

Bases: object

Metadata properties of the tracking entity, trial, or trial component.

Parameters:

commit_id (Optional[str]) – The commit ID.
generated_by (Optional[str]) – The entity this entity was generated by.
project_id (Optional[str]) – The project ID.
repository (Optional[str]) – The repository.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-experimenttrialcomponent-metadataproperties.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

metadata_properties_property = sagemaker.CfnExperimentTrialComponentPropsMixin.MetadataPropertiesProperty(
    commit_id="commitId",
    generated_by="generatedBy",
    project_id="projectId",
    repository="repository"
)

Attributes

commit_id

The commit ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-experimenttrialcomponent-metadataproperties.html#cfn-sagemaker-experimenttrialcomponent-metadataproperties-commitid

generated_by

The entity this entity was generated by.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-experimenttrialcomponent-metadataproperties.html#cfn-sagemaker-experimenttrialcomponent-metadataproperties-generatedby

project_id

The project ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-experimenttrialcomponent-metadataproperties.html#cfn-sagemaker-experimenttrialcomponent-metadataproperties-projectid

repository

The repository.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-experimenttrialcomponent-metadataproperties.html#cfn-sagemaker-experimenttrialcomponent-metadataproperties-repository

StatusProperty

class CfnExperimentTrialComponentPropsMixin.StatusProperty(*, message=None, primary_status=None)

Bases: object

The status of the trial component.

Parameters:

message (Optional[str]) – If the component failed, a message describing why.
primary_status (Optional[str]) – The status of the trial component.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-experimenttrialcomponent-status.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

status_property = sagemaker.CfnExperimentTrialComponentPropsMixin.StatusProperty(
    message="message",
    primary_status="primaryStatus"
)

Attributes

message

If the component failed, a message describing why.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-experimenttrialcomponent-status.html#cfn-sagemaker-experimenttrialcomponent-status-message

primary_status

The status of the trial component.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-experimenttrialcomponent-status.html#cfn-sagemaker-experimenttrialcomponent-status-primarystatus

TagsItemsProperty

class CfnExperimentTrialComponentPropsMixin.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-experimenttrialcomponent-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.CfnExperimentTrialComponentPropsMixin.TagsItemsProperty(
    key="key",
    value="value"
)

Attributes

key

The tag key.

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

value

The tag value.

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