interface CfnTrainingDatasetProps

Language	Type name
.NET	`Amazon.CDK.aws_cleanroomsml.CfnTrainingDatasetProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscleanroomsml#CfnTrainingDatasetProps`
Java	`software.amazon.awscdk.services.cleanroomsml.CfnTrainingDatasetProps`
Python	`aws_cdk.aws_cleanroomsml.CfnTrainingDatasetProps`
TypeScript	`aws-cdk-lib` » `aws_cleanroomsml` » `CfnTrainingDatasetProps`

Properties for defining a CfnTrainingDataset.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cleanroomsml as cleanroomsml } from 'aws-cdk-lib';
const cfnTrainingDatasetProps: cleanroomsml.CfnTrainingDatasetProps = {
  name: 'name',
  roleArn: 'roleArn',
  trainingData: [{
    inputConfig: {
      dataSource: {
        glueDataSource: {
          databaseName: 'databaseName',
          tableName: 'tableName',

          // the properties below are optional
          catalogId: 'catalogId',
        },
      },
      schema: [{
        columnName: 'columnName',
        columnTypes: ['columnTypes'],
      }],
    },
    type: 'type',
  }],

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

Properties

Name	Type	Description
name	`string`	The name of the training dataset.
roleArn	`string`	The ARN of the IAM role that Clean Rooms ML can assume to read the data referred to in the `dataSource` field of each dataset.
trainingData	`IResolvable` `\| (IResolvable` `\|` `DatasetProperty)[]`	An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema.
description?	`string`	The description of the training dataset.
tags?	`CfnTag[]`	The optional metadata that you apply to the resource to help you categorize and organize them.

name

Type: string

The name of the training dataset.

roleArn

Type: string

The ARN of the IAM role that Clean Rooms ML can assume to read the data referred to in the dataSource field of each dataset.

Passing a role across accounts is not allowed. If you pass a role that isn't in your account, you get an AccessDeniedException error.

trainingData

Type: IResolvable | (IResolvable | DatasetProperty)[]

An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema.

You must provide a role that has read access to these tables.

description?

Type: string (optional)

The description of the training dataset.

tags?

Type: CfnTag[] (optional)

The optional metadata that you apply to the resource to help you categorize and organize them.

Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : /