CfnArtifactPropsMixin

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

Bases: Mixin

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

An artifact is a lineage tracking entity that represents a URI addressable object or data, such as an S3 URI of a dataset or the ECR registry path of an image.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-artifact.html
CloudformationResource:: AWS::SageMaker::Artifact
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_artifact_props_mixin = sagemaker.CfnArtifactPropsMixin(sagemaker.CfnArtifactMixinProps(
    artifact_name="artifactName",
    artifact_type="artifactType",
    metadata_properties=sagemaker.CfnArtifactPropsMixin.MetadataPropertiesProperty(
        commit_id="commitId",
        generated_by="generatedBy",
        project_id="projectId",
        repository="repository"
    ),
    properties={
        "properties_key": "properties"
    },
    source=sagemaker.CfnArtifactPropsMixin.ArtifactSourceProperty(
        source_types=[sagemaker.CfnArtifactPropsMixin.ArtifactSourceTypeProperty(
            source_id_type="sourceIdType",
            value="value"
        )],
        source_uri="sourceUri"
    ),
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

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

Parameters:

props (Union[CfnArtifactMixinProps, 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 = ['artifactName', 'artifactType', 'metadataProperties', 'properties', 'source', '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.

ArtifactSourceProperty

class CfnArtifactPropsMixin.ArtifactSourceProperty(*, source_types=None, source_uri=None)

Bases: object

Parameters:

source_types (Union[IResolvable, Sequence[Union[IResolvable, ArtifactSourceTypeProperty, Dict[str, Any]]], None]) – A list of source types.
source_uri (Optional[str]) – The URI of the source.

See:

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

artifact_source_property = sagemaker.CfnArtifactPropsMixin.ArtifactSourceProperty(
    source_types=[sagemaker.CfnArtifactPropsMixin.ArtifactSourceTypeProperty(
        source_id_type="sourceIdType",
        value="value"
    )],
    source_uri="sourceUri"
)

Attributes

source_types

A list of source types.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-artifact-artifactsource.html#cfn-sagemaker-artifact-artifactsource-sourcetypes

source_uri

The URI of the source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-artifact-artifactsource.html#cfn-sagemaker-artifact-artifactsource-sourceuri

ArtifactSourceTypeProperty

class CfnArtifactPropsMixin.ArtifactSourceTypeProperty(*, source_id_type=None, value=None)

Bases: object

Parameters:

source_id_type (Optional[str]) – The type of ID.
value (Optional[str]) – The ID.

See:

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

artifact_source_type_property = sagemaker.CfnArtifactPropsMixin.ArtifactSourceTypeProperty(
    source_id_type="sourceIdType",
    value="value"
)

Attributes

source_id_type

The type of ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-artifact-artifactsourcetype.html#cfn-sagemaker-artifact-artifactsourcetype-sourceidtype

value

The ID.

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

MetadataPropertiesProperty

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

Bases: object

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-artifact-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.CfnArtifactPropsMixin.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-artifact-metadataproperties.html#cfn-sagemaker-artifact-metadataproperties-commitid

generated_by

The entity this entity was generated by.

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

project_id

The project ID.

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

repository

The repository.

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