Package software.amazon.awscdk.services.sagemaker

Interface CfnArtifactProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnArtifactProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:18.386Z")
@Stability(Stable)
public interface CfnArtifactProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnArtifact.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 CfnArtifactProps cfnArtifactProps = CfnArtifactProps.builder()
         .artifactType("artifactType")
         .source(ArtifactSourceProperty.builder()
                 .sourceUri("sourceUri")
                 // the properties below are optional
                 .sourceTypes(List.of(ArtifactSourceTypeProperty.builder()
                         .sourceIdType("sourceIdType")
                         .value("value")
                         .build()))
                 .build())
         // the properties below are optional
         .artifactName("artifactName")
         .metadataProperties(MetadataPropertiesProperty.builder()
                 .commitId("commitId")
                 .generatedBy("generatedBy")
                 .projectId("projectId")
                 .repository("repository")
                 .build())
         .properties(Map.of(
                 "propertiesKey", "properties"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnArtifactProps.Builder	A builder for CfnArtifactProps
static final class	CfnArtifactProps.Jsii$Proxy	An implementation for CfnArtifactProps

Method Summary

Modifier and Type	Method	Description
static CfnArtifactProps.Builder	builder()
default String	getArtifactName()	The name of the artifact.
String	getArtifactType()	The artifact type.
default Object	getMetadataProperties()	Returns union: either IResolvable or CfnArtifact.MetadataPropertiesProperty
default Object	getProperties()	A list of properties to add to the artifact.
Object	getSource()	Returns union: either IResolvable or CfnArtifact.ArtifactSourceProperty
default List<CfnTag>	getTags()	A list of tags to apply to the artifact.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getArtifactType

@Stability(Stable)
@NotNull
String getArtifactType()

The artifact type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-artifact.html#cfn-sagemaker-artifact-artifacttype

getSource

@Stability(Stable)
@NotNull
Object getSource()

Returns union: either IResolvable or CfnArtifact.ArtifactSourceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-artifact.html#cfn-sagemaker-artifact-source

getArtifactName

@Stability(Stable)
@Nullable
default String getArtifactName()

The name of the artifact.

Must be unique to your account in an AWS Region.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-artifact.html#cfn-sagemaker-artifact-artifactname

getMetadataProperties

@Stability(Stable)
@Nullable
default Object getMetadataProperties()

Returns union: either IResolvable or CfnArtifact.MetadataPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-artifact.html#cfn-sagemaker-artifact-metadataproperties

getProperties

@Stability(Stable)
@Nullable
default Object getProperties()

A list of properties to add to the artifact.

Returns union: either IResolvable or Mapinvalid input: '<'String, String>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-artifact.html#cfn-sagemaker-artifact-properties

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A list of tags to apply to the artifact.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-artifact.html#cfn-sagemaker-artifact-tags

builder

@Stability(Stable)
static CfnArtifactProps.Builder builder()

Returns:

a CfnArtifactProps.Builder of CfnArtifactProps