Package software.amazon.awscdk.services.sagemaker

Interface CfnExperimentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnExperimentProps.Jsii$Proxy

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

Properties for defining a CfnExperiment.

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.*;
 CfnExperimentProps cfnExperimentProps = CfnExperimentProps.builder()
         .experimentName("experimentName")
         // the properties below are optional
         .description("description")
         .displayName("displayName")
         .tags(List.of(TagsItemsProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnExperimentProps.Builder	builder()
default String	getDescription()	The description of the experiment.
default String	getDisplayName()	The name of the experiment as displayed.
String	getExperimentName()	The name of the experiment.
default List<CfnExperiment.TagsItemsProperty>	getTags()	A list of tags to associate with the experiment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExperimentName

@Stability(Stable)
@NotNull
String getExperimentName()

The name of the experiment.

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-experiment.html#cfn-sagemaker-experiment-experimentname

getDescription

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

The description of the experiment.

See Also:

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

getDisplayName

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

The name of the experiment as displayed.

The name does not need to be unique.

See Also:

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

getTags

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

A list of tags to associate with the experiment.

See Also:

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

builder

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

Returns:

a CfnExperimentProps.Builder of CfnExperimentProps