CfnTrainingDatasetProps

class aws_cdk.aws_cleanroomsml.CfnTrainingDatasetProps(*, name, role_arn, training_data, description=None, tags=None)

Bases: object

Properties for defining a CfnTrainingDataset.

Parameters:

  • name (str) – The name of the training dataset.

  • role_arn (str) – 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.

  • training_data (Union[IResolvable, Sequence[Union[IResolvable, DatasetProperty, Dict[str, Any]]]]) – 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 (Optional[str]) – The description of the training dataset.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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: + - = . _ : /

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanroomsml-trainingdataset.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cleanroomsml as cleanroomsml

cfn_training_dataset_props = cleanroomsml.CfnTrainingDatasetProps(
    name="name",
    role_arn="roleArn",
    training_data=[cleanroomsml.CfnTrainingDataset.DatasetProperty(
        input_config=cleanroomsml.CfnTrainingDataset.DatasetInputConfigProperty(
            data_source=cleanroomsml.CfnTrainingDataset.DataSourceProperty(
                glue_data_source=cleanroomsml.CfnTrainingDataset.GlueDataSourceProperty(
                    database_name="databaseName",
                    table_name="tableName",

                    # the properties below are optional
                    catalog_id="catalogId"
                )
            ),
            schema=[cleanroomsml.CfnTrainingDataset.ColumnSchemaProperty(
                column_name="columnName",
                column_types=["columnTypes"]
            )]
        ),
        type="type"
    )],

    # the properties below are optional
    description="description",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

The description of the training dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanroomsml-trainingdataset.html#cfn-cleanroomsml-trainingdataset-description

name

The name of the training dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanroomsml-trainingdataset.html#cfn-cleanroomsml-trainingdataset-name

role_arn

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanroomsml-trainingdataset.html#cfn-cleanroomsml-trainingdataset-rolearn

tags

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: + - = . _ : /

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanroomsml-trainingdataset.html#cfn-cleanroomsml-trainingdataset-tags

.

  • Tag keys and values are case sensitive.

  • Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for keys as it is reserved. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

training_data

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanroomsml-trainingdataset.html#cfn-cleanroomsml-trainingdataset-trainingdata