interface CfnExperimentProps

Language	Type name
.NET	Amazon.CDK.AWS.Sagemaker.CfnExperimentProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnExperimentProps
Java	software.amazon.awscdk.services.sagemaker.CfnExperimentProps
Python	aws_cdk.aws_sagemaker.CfnExperimentProps
TypeScript	aws-cdk-lib » aws_sagemaker » CfnExperimentProps

Properties for defining a CfnExperiment.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const cfnExperimentProps: sagemaker.CfnExperimentProps = {
  experimentName: 'experimentName',

  // the properties below are optional
  description: 'description',
  displayName: 'displayName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
experimentName	string	The name of the experiment.
description?	string	The description of the experiment.
displayName?	string	The name of the experiment as displayed.
tags?	TagsItemsProperty[]	A list of tags to associate with the experiment.

---

experimentName

Type: string

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

---

description?

Type: string (optional)

The description of the experiment.

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

---

displayName?

Type: string (optional)

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

---

tags?

Type: TagsItemsProperty[] (optional)

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