Package software.amazon.awscdk.services.sagemaker

Class CfnExperimentTrialComponent

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.sagemaker.CfnExperimentTrialComponent
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IExperimentTrialComponentRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-08-10T14:51:11.314Z") @Stability(Stable) public class CfnExperimentTrialComponent extends CfnResource implements IInspectable, IExperimentTrialComponentRef, ITaggableV2
Resource type definition for AWS SageMaker Experiment Trial Component.

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.*;
 CfnExperimentTrialComponent cfnExperimentTrialComponent = CfnExperimentTrialComponent.Builder.create(this, "MyCfnExperimentTrialComponent")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnExperimentTrialComponent

      protected CfnExperimentTrialComponent(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnExperimentTrialComponent

      protected CfnExperimentTrialComponent(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnExperimentTrialComponent

      @Stability(Stable) public CfnExperimentTrialComponent(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnExperimentTrialComponentProps props)
      Create a new AWS::SageMaker::ExperimentTrialComponent.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForExperimentTrialComponent

      @Stability(Stable) @NotNull public static String arnForExperimentTrialComponent(@NotNull IExperimentTrialComponentRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnExperimentTrialComponent

      @Stability(Stable) @NotNull public static Boolean isCfnExperimentTrialComponent(@NotNull Object x)
      Checks whether the given object is a CfnExperimentTrialComponent.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the trial component.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      When the component was created.

    • getAttrLastModifiedTime

      @Stability(Stable) @NotNull public String getAttrLastModifiedTime()
      When the component was last modified.

    • getAttrLineageGroupArn

      @Stability(Stable) @NotNull public String getAttrLineageGroupArn()
      The Amazon Resource Name (ARN) of the lineage group.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getExperimentTrialComponentRef

      @Stability(Stable) @NotNull public ExperimentTrialComponentReference getExperimentTrialComponentRef()
      A reference to a ExperimentTrialComponent resource.
      Specified by:
      getExperimentTrialComponentRef in interface IExperimentTrialComponentRef

    • getTrialComponentName

      @Stability(Stable) @NotNull public String getTrialComponentName()
      The name of the trial component.

    • setTrialComponentName

      @Stability(Stable) public void setTrialComponentName(@NotNull String value)
      The name of the trial component.

    • getDisplayName

      @Stability(Stable) @Nullable public String getDisplayName()
      The name of the component as displayed.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@Nullable String value)
      The name of the component as displayed.

    • getEndTime

      @Stability(Stable) @Nullable public String getEndTime()
      When the component ended.

    • setEndTime

      @Stability(Stable) public void setEndTime(@Nullable String value)
      When the component ended.

    • getMetadataProperties

      @Stability(Stable) @Nullable public Object getMetadataProperties()
      Metadata properties of the tracking entity, trial, or trial component.

      Returns union: either IResolvable or CfnExperimentTrialComponent.MetadataPropertiesProperty

    • setMetadataProperties

      @Stability(Stable) public void setMetadataProperties(@Nullable IResolvable value)
      Metadata properties of the tracking entity, trial, or trial component.

    • setMetadataProperties

      @Stability(Stable) public void setMetadataProperties(@Nullable CfnExperimentTrialComponent.MetadataPropertiesProperty value)
      Metadata properties of the tracking entity, trial, or trial component.

    • getStartTime

      @Stability(Stable) @Nullable public String getStartTime()
      When the component started.

    • setStartTime

      @Stability(Stable) public void setStartTime(@Nullable String value)
      When the component started.

    • getStatus

      @Stability(Stable) @Nullable public Object getStatus()
      The status of the trial component.

      Returns union: either IResolvable or CfnExperimentTrialComponent.StatusProperty

    • setStatus

      @Stability(Stable) public void setStatus(@Nullable IResolvable value)
      The status of the trial component.

    • setStatus

      @Stability(Stable) public void setStatus(@Nullable CfnExperimentTrialComponent.StatusProperty value)
      The status of the trial component.

    • getTags

      @Stability(Stable) @Nullable public List<CfnExperimentTrialComponent.TagsItemsProperty> getTags()
      A list of tags to associate with the component.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnExperimentTrialComponent.TagsItemsProperty> value)
      A list of tags to associate with the component.