Skip to content
v2.274.0

CfnTrainingDatasetProps Struct ​

Properties for defining a CfnTrainingDataset.

Example ​

ts
// 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 ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the training dataset.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the training dataset.
roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*stringrequired#
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.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The optional metadata that you apply to the resource to help you categorize and organize them.
notes

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: + - = . _ : /
trainingDataIResolvable | IResolvable | CfnTrainingDataset.DatasetProperty[]training_datatyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DatasetProperty]]]trainingDataIResolvableTrainingDataIResolvableTrainingDatainterface{}required#
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.