Package software.amazon.awscdk.services.sagemaker

Class CfnTrialComponent

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.CfnTrialComponent
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ITrialComponentRef, 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.577Z") @Stability(Stable) public class CfnTrialComponent extends CfnResource implements IInspectable, ITrialComponentRef, ITaggableV2
Resource type definition for AWS::SageMaker::TrialComponent.

A trial component is a stage of a machine learning trial, such as a preprocessing job, training job, or batch transform job.

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.*;
 CfnTrialComponent cfnTrialComponent = CfnTrialComponent.Builder.create(this, "MyCfnTrialComponent")
         .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:

  • 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

    • CfnTrialComponent

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

    • CfnTrialComponent

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

    • CfnTrialComponent

      @Stability(Stable) public CfnTrialComponent(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnTrialComponentProps props)
      Create a new AWS::SageMaker::TrialComponent.

      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

    • arnForTrialComponent

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

    • isCfnTrialComponent

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

      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.

    • getAttrCreationTime

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

    • getAttrLastModifiedTime

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

    • getAttrLineageGroupArn

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

    • getAttrTrialComponentArn

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

    • 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

    • getTrialComponentRef

      @Stability(Stable) @NotNull public TrialComponentReference getTrialComponentRef()
      A reference to a TrialComponent resource.
      Specified by:
      getTrialComponentRef in interface ITrialComponentRef

    • 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.

    • getInputArtifacts

      @Stability(Stable) @Nullable public Object getInputArtifacts()
      The input artifacts for the component.

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

    • setInputArtifacts

      @Stability(Stable) public void setInputArtifacts(@Nullable IResolvable value)
      The input artifacts for the component.

    • setInputArtifacts

      @Stability(Stable) public void setInputArtifacts(@Nullable Map<String,Object> value)
      The input artifacts for the component.

    • getMetadataProperties

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

      Returns union: either IResolvable or CfnTrialComponent.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 CfnTrialComponent.MetadataPropertiesProperty value)
      Metadata properties of the tracking entity, trial, or trial component.

    • getOutputArtifacts

      @Stability(Stable) @Nullable public Object getOutputArtifacts()
      The output artifacts for the component.

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

    • setOutputArtifacts

      @Stability(Stable) public void setOutputArtifacts(@Nullable IResolvable value)
      The output artifacts for the component.

    • setOutputArtifacts

      @Stability(Stable) public void setOutputArtifacts(@Nullable Map<String,Object> value)
      The output artifacts for the component.

    • getParameters

      @Stability(Stable) @Nullable public Object getParameters()
      The hyperparameters for the component.

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

    • setParameters

      @Stability(Stable) public void setParameters(@Nullable IResolvable value)
      The hyperparameters for the component.

    • setParameters

      @Stability(Stable) public void setParameters(@Nullable Map<String,Object> value)
      The hyperparameters for the component.

    • getStatus

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

      Returns union: either IResolvable or CfnTrialComponent.TrialComponentStatusProperty

    • setStatus

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

    • setStatus

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

    • getTags

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

    • setTags

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