Package software.amazon.awscdk.services.sagemaker

Interface CfnProcessingJob.ExperimentConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProcessingJob.ExperimentConfigProperty.Jsii$Proxy

Enclosing class:

CfnProcessingJob

@Stability(Stable)
public static interface CfnProcessingJob.ExperimentConfigProperty
extends software.amazon.jsii.JsiiSerializable

Associates a SageMaker job as a trial component with an experiment and trial.

Specified when you call the CreateProcessingJob API.

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.*;
 ExperimentConfigProperty experimentConfigProperty = ExperimentConfigProperty.builder()
         .experimentName("experimentName")
         .runName("runName")
         .trialComponentDisplayName("trialComponentDisplayName")
         .trialName("trialName")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-experimentconfig.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnProcessingJob.ExperimentConfigProperty.Builder	builder()
default String	getExperimentName()	The name of an existing experiment to associate with the trial component.
default String	getRunName()	The name of the experiment run to associate with the trial component.
default String	getTrialComponentDisplayName()	The display name for the trial component.
default String	getTrialName()	The name of an existing trial to associate the trial component with.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExperimentName

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

The name of an existing experiment to associate with the trial component.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-experimentconfig.html#cfn-sagemaker-processingjob-experimentconfig-experimentname

getRunName

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

The name of the experiment run to associate with the trial component.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-experimentconfig.html#cfn-sagemaker-processingjob-experimentconfig-runname

getTrialComponentDisplayName

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

The display name for the trial component.

If this key isn't specified, the display name is the trial component name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-experimentconfig.html#cfn-sagemaker-processingjob-experimentconfig-trialcomponentdisplayname

getTrialName

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

The name of an existing trial to associate the trial component with.

If not specified, a new trial is created.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-experimentconfig.html#cfn-sagemaker-processingjob-experimentconfig-trialname

builder

@Stability(Stable)
static CfnProcessingJob.ExperimentConfigProperty.Builder builder()

Returns:

a CfnProcessingJob.ExperimentConfigProperty.Builder of CfnProcessingJob.ExperimentConfigProperty