AWS CDK Reference

Appearance

v2.274.0

CfnArtifactProps Struct ​

Properties for defining a CfnArtifact.

Source
Generated code
Type last changed
v2.268.0 · 2 Sep 2026

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const cfnArtifactProps: sagemaker.CfnArtifactProps = {
  artifactType: 'artifactType',
  source: {
    sourceUri: 'sourceUri',

    // the properties below are optional
    sourceTypes: [{
      sourceIdType: 'sourceIdType',
      value: 'value',
    }],
  },

  // the properties below are optional
  artifactName: 'artifactName',
  metadataProperties: {
    commitId: 'commitId',
    generatedBy: 'generatedBy',
    projectId: 'projectId',
    repository: 'repository',
  },
  properties: {
    propertiesKey: 'properties',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

artifactNamestringartifact_namestrartifactNameStringArtifactNamestringArtifactName*string#
The name of the artifact.

Must be unique to your account in an AWS Region.

artifactTypestringartifact_typestrartifactTypeStringArtifactTypestringArtifactType*stringrequired#
The artifact type.
metadataPropertiesIResolvable | CfnArtifact.MetadataPropertiesPropertymetadata_propertiestyping.Union[IResolvable, MetadataPropertiesProperty]metadataPropertiesIResolvableMetadataPropertiesIResolvableMetadataPropertiesinterface{}#
propertiesIResolvable | { [key: string]: string }propertiestyping.Union[IResolvable, typing.Mapping[str, str]]propertiesIResolvablePropertiesIResolvablePropertiesinterface{}#
A list of properties to add to the artifact.
sourceIResolvable | CfnArtifact.ArtifactSourcePropertysourcetyping.Union[IResolvable, ArtifactSourceProperty]sourceIResolvableSourceIResolvableSourceinterface{}required#
tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
A list of tags to apply to the artifact.