Package software.amazon.awscdk.services.sagemaker

Interface CfnExperimentTrialComponentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnExperimentTrialComponentProps.Jsii$Proxy

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

Properties for defining a CfnExperimentTrialComponent.

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.*;
 CfnExperimentTrialComponentProps cfnExperimentTrialComponentProps = CfnExperimentTrialComponentProps.builder()
         .trialComponentName("trialComponentName")
         // the properties below are optional
         .displayName("displayName")
         .endTime("endTime")
         .metadataProperties(MetadataPropertiesProperty.builder()
                 .commitId("commitId")
                 .generatedBy("generatedBy")
                 .projectId("projectId")
                 .repository("repository")
                 .build())
         .startTime("startTime")
         .status(StatusProperty.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-experimenttrialcomponent.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnExperimentTrialComponentProps.Builder	builder()
default String	getDisplayName()	The name of the component as displayed.
default String	getEndTime()	When the component ended.
default Object	getMetadataProperties()	Metadata properties of the tracking entity, trial, or trial component.
default String	getStartTime()	When the component started.
default Object	getStatus()	The status of the trial component.
default List<CfnExperimentTrialComponent.TagsItemsProperty>	getTags()	A list of tags to associate with the 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.

The name 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-experimenttrialcomponent.html#cfn-sagemaker-experimenttrialcomponent-trialcomponentname

getDisplayName

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

The name of the component as displayed.

The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.

See Also:

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

getEndTime

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

When the component ended.

See Also:

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

getMetadataProperties

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

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

Returns union: either IResolvable or CfnExperimentTrialComponent.MetadataPropertiesProperty

See Also:

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

getStartTime

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

When the component started.

See Also:

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

getStatus

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

The status of the trial component.

Returns union: either IResolvable or CfnExperimentTrialComponent.StatusProperty

See Also:

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

getTags

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

A list of tags to associate with the component.

See Also:

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

builder

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

Returns:

a CfnExperimentTrialComponentProps.Builder of CfnExperimentTrialComponentProps