interface CfnTrialComponentProps

Language	Type name
.NET	`Amazon.CDK.AWS.Sagemaker.CfnTrialComponentProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnTrialComponentProps`
Java	`software.amazon.awscdk.services.sagemaker.CfnTrialComponentProps`
Python	`aws_cdk.aws_sagemaker.CfnTrialComponentProps`
TypeScript	`aws-cdk-lib` » `aws_sagemaker` » `CfnTrialComponentProps`

Properties for defining a CfnTrialComponent.

Example

// 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

Name	Type	Description
trialComponentName	`string`	The name of the trial component.
displayName?	`string`	The name of the component as displayed.
inputArtifacts?	`IResolvable` `\| { [string]:` `IResolvable` `\|` `TrialComponentArtifactProperty` `}`	The input artifacts for the component.
metadataProperties?	`IResolvable` `\|` `MetadataPropertiesProperty`	Metadata properties of the tracking entity, trial, or trial component.
outputArtifacts?	`IResolvable` `\| { [string]:` `IResolvable` `\|` `TrialComponentArtifactProperty` `}`	The output artifacts for the component.
parameters?	`IResolvable` `\| { [string]:` `IResolvable` `\|` `TrialComponentParameterValueProperty` `}`	The hyperparameters for the component.
status?	`IResolvable` `\|` `TrialComponentStatusProperty`	The status of the trial component.
tags?	`TagsItemsProperty[]`	A list of tags to associate with the trial component.

trialComponentName

Type: string

The name of the trial component.

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

displayName?

Type: string (optional)

The name of the component as displayed.

If DisplayName isn't specified, TrialComponentName is displayed.

inputArtifacts?

Type: IResolvable | { [string]: IResolvable | TrialComponentArtifactProperty } (optional)

The input artifacts for the component.

metadataProperties?

Type: IResolvable | MetadataPropertiesProperty (optional)

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

outputArtifacts?

Type: IResolvable | { [string]: IResolvable | TrialComponentArtifactProperty } (optional)

The output artifacts for the component.

parameters?

Type: IResolvable | { [string]: IResolvable | TrialComponentParameterValueProperty } (optional)

The hyperparameters for the component.

status?

Type: IResolvable | TrialComponentStatusProperty (optional)

The status of the trial component.

tags?

Type: TagsItemsProperty[] (optional)

A list of tags to associate with the trial component.

AWS CDK

2.264.0