Package software.amazon.awscdk.services.sagemaker

Interface CfnTrialComponentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTrialComponentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-08-10T14:51:11.595Z")
@Stability(Stable)
public interface CfnTrialComponentProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.sagemaker.*;
 CfnTrialComponentProps cfnTrialComponentProps = CfnTrialComponentProps.builder()
         .trialComponentName("trialComponentName")
         // the properties below are optional
         .displayName("displayName")
         .inputArtifacts(Map.of(
                 "inputArtifactsKey", TrialComponentArtifactProperty.builder()
                         .value("value")
                         // the properties below are optional
                         .mediaType("mediaType")
                         .build()))
         .metadataProperties(MetadataPropertiesProperty.builder()
                 .commitId("commitId")
                 .generatedBy("generatedBy")
                 .projectId("projectId")
                 .repository("repository")
                 .build())
         .outputArtifacts(Map.of(
                 "outputArtifactsKey", TrialComponentArtifactProperty.builder()
                         .value("value")
                         // the properties below are optional
                         .mediaType("mediaType")
                         .build()))
         .parameters(Map.of(
                 "parametersKey", TrialComponentParameterValueProperty.builder()
                         .numberValue(123)
                         .stringValue("stringValue")
                         .build()))
         .status(TrialComponentStatusProperty.builder()
                 .message("message")
                 .primaryStatus("primaryStatus")
                 .build())
         .tags(List.of(TagsItemsProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTrialComponentProps.Builder	builder()
default String	getDisplayName()	The name of the component as displayed.
default Object	getInputArtifacts()	The input artifacts for the component.
default Object	getMetadataProperties()	Metadata properties of the tracking entity, trial, or trial component.
default Object	getOutputArtifacts()	The output artifacts for the component.
default Object	getParameters()	The hyperparameters for the component.
default Object	getStatus()	The status of the trial component.
default List<CfnTrialComponent.TagsItemsProperty>	getTags()	A list of tags to associate with the trial component.
String	getTrialComponentName()	The name of the trial component.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTrialComponentName

@Stability(Stable)
@NotNull
String getTrialComponentName()

The name of the trial component.

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

See Also:

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

getDisplayName

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

The name of the component as displayed.

If DisplayName isn't specified, TrialComponentName is displayed.

See Also:

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

getInputArtifacts

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

The input artifacts for the component.

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

See Also:

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

getMetadataProperties

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

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

Returns union: either IResolvable or CfnTrialComponent.MetadataPropertiesProperty

See Also:

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

getOutputArtifacts

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

The output artifacts for the component.

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

See Also:

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

getParameters

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

The hyperparameters for the component.

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

See Also:

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

getStatus

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

The status of the trial component.

Returns union: either IResolvable or CfnTrialComponent.TrialComponentStatusProperty

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTrialComponent.TagsItemsProperty> getTags()

A list of tags to associate with the trial component.

See Also:

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

builder

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

Returns:

a CfnTrialComponentProps.Builder of CfnTrialComponentProps