Package software.amazon.awscdk.services.cleanroomsml

Interface CfnTrainingDatasetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTrainingDatasetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-17T05:10:06.744Z")
@Stability(Stable)
public interface CfnTrainingDatasetProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.cleanroomsml.*;
 CfnTrainingDatasetProps cfnTrainingDatasetProps = CfnTrainingDatasetProps.builder()
         .name("name")
         .roleArn("roleArn")
         .trainingData(List.of(DatasetProperty.builder()
                 .inputConfig(DatasetInputConfigProperty.builder()
                         .dataSource(DataSourceProperty.builder()
                                 .glueDataSource(GlueDataSourceProperty.builder()
                                         .databaseName("databaseName")
                                         .tableName("tableName")
                                         // the properties below are optional
                                         .catalogId("catalogId")
                                         .build())
                                 .build())
                         .schema(List.of(ColumnSchemaProperty.builder()
                                 .columnName("columnName")
                                 .columnTypes(List.of("columnTypes"))
                                 .build()))
                         .build())
                 .type("type")
                 .build()))
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTrainingDatasetProps.Builder	builder()
default String	getDescription()	The description of the training dataset.
String	getName()	The name of the training dataset.
String	getRoleArn()	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.
default List<CfnTag>	getTags()	The optional metadata that you apply to the resource to help you categorize and organize them.
Object	getTrainingData()	An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the training dataset.

See Also:

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

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

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 Also:

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

getTrainingData

@Stability(Stable)
@NotNull
Object getTrainingData()

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 Also:

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

getDescription

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

The description of the training dataset.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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 Also:

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

builder

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

Returns:

a CfnTrainingDatasetProps.Builder of CfnTrainingDatasetProps