Skip to content
v2.274.0

CfnTrialComponentProps Struct ​

Properties for defining a CfnTrialComponent.

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 cfnTrialComponentProps: sagemaker.CfnTrialComponentProps = {
  trialComponentName: 'trialComponentName',

  // the properties below are optional
  displayName: 'displayName',
  inputArtifacts: {
    inputArtifactsKey: {
      value: 'value',

      // the properties below are optional
      mediaType: 'mediaType',
    },
  },
  metadataProperties: {
    commitId: 'commitId',
    generatedBy: 'generatedBy',
    projectId: 'projectId',
    repository: 'repository',
  },
  outputArtifacts: {
    outputArtifactsKey: {
      value: 'value',

      // the properties below are optional
      mediaType: 'mediaType',
    },
  },
  parameters: {
    parametersKey: {
      numberValue: 123,
      stringValue: 'stringValue',
    },
  },
  status: {
    message: 'message',
    primaryStatus: 'primaryStatus',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

displayNameoptionalstringdisplay_nameoptionalstrdisplayNameoptionalStringDisplayNameoptionalstringDisplayNameoptional*string#
The name of the component as displayed.

If DisplayName isn't specified, TrialComponentName is displayed.

inputArtifactsoptionalIResolvable | { [key: string]: IResolvable | CfnTrialComponent.TrialComponentArtifactProperty }input_artifactsoptionaltyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, TrialComponentArtifactProperty]]]inputArtifactsoptionalIResolvableInputArtifactsoptionalIResolvableInputArtifactsoptionalinterface{}#
The input artifacts for the component.
metadataPropertiesoptionalIResolvable | CfnTrialComponent.MetadataPropertiesPropertymetadata_propertiesoptionaltyping.Union[IResolvable, MetadataPropertiesProperty]metadataPropertiesoptionalIResolvableMetadataPropertiesoptionalIResolvableMetadataPropertiesoptionalinterface{}#
Metadata properties of the tracking entity, trial, or trial component.
outputArtifactsoptionalIResolvable | { [key: string]: IResolvable | CfnTrialComponent.TrialComponentArtifactProperty }output_artifactsoptionaltyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, TrialComponentArtifactProperty]]]outputArtifactsoptionalIResolvableOutputArtifactsoptionalIResolvableOutputArtifactsoptionalinterface{}#
The output artifacts for the component.
parametersoptionalIResolvable | { [key: string]: IResolvable | CfnTrialComponent.TrialComponentParameterValueProperty }parametersoptionaltyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, TrialComponentParameterValueProperty]]]parametersoptionalIResolvableParametersoptionalIResolvableParametersoptionalinterface{}#
The hyperparameters for the component.
statusoptionalIResolvable | CfnTrialComponent.TrialComponentStatusPropertystatusoptionaltyping.Union[IResolvable, TrialComponentStatusProperty]statusoptionalIResolvableStatusoptionalIResolvableStatusoptionalinterface{}#
The status of the trial component.
tagsoptionalCfnTrialComponent.TagsItemsProperty[]tagsoptionaltyping.List[TagsItemsProperty]tagsoptionalList<TagsItemsProperty>TagsoptionalTagsItemsProperty[]Tagsoptional*[]TagsItemsProperty#
A list of tags to associate with the trial component.
trialComponentNamestringtrial_component_namestrtrialComponentNameStringTrialComponentNamestringTrialComponentName*stringrequired#
The name of the trial component.

Must be unique in your AWS account and is not case-sensitive.