Class CfnTrainingDatasetProps

Properties for defining a CfnTrainingDataset.

Inheritance

object

CfnTrainingDatasetProps

Implements

ICfnTrainingDatasetProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.CleanRoomsML

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnTrainingDatasetProps : ICfnTrainingDatasetProps

Syntax (vb)

Public Class CfnTrainingDatasetProps Implements ICfnTrainingDatasetProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CleanRoomsML;

             var cfnTrainingDatasetProps = new CfnTrainingDatasetProps {
                 Name = "name",
                 RoleArn = "roleArn",
                 TrainingData = new [] { new DatasetProperty {
                     InputConfig = new DatasetInputConfigProperty {
                         DataSource = new DataSourceProperty {
                             GlueDataSource = new GlueDataSourceProperty {
                                 DatabaseName = "databaseName",
                                 TableName = "tableName",

                                 // the properties below are optional
                                 CatalogId = "catalogId"
                             }
                         },
                         Schema = new [] { new ColumnSchemaProperty {
                             ColumnName = "columnName",
                             ColumnTypes = new [] { "columnTypes" }
                         } }
                     },
                     Type = "type"
                 } },

                 // the properties below are optional
                 Description = "description",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnTrainingDatasetProps()

Properties for defining a CfnTrainingDataset.

Properties

Description	The description of the training dataset.
Name	The name of the training dataset.
RoleArn	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.
Tags	The optional metadata that you apply to the resource to help you categorize and organize them.
TrainingData	An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema.

Constructors

CfnTrainingDatasetProps()

Properties for defining a CfnTrainingDataset.

public CfnTrainingDatasetProps()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CleanRoomsML;

             var cfnTrainingDatasetProps = new CfnTrainingDatasetProps {
                 Name = "name",
                 RoleArn = "roleArn",
                 TrainingData = new [] { new DatasetProperty {
                     InputConfig = new DatasetInputConfigProperty {
                         DataSource = new DataSourceProperty {
                             GlueDataSource = new GlueDataSourceProperty {
                                 DatabaseName = "databaseName",
                                 TableName = "tableName",

                                 // the properties below are optional
                                 CatalogId = "catalogId"
                             }
                         },
                         Schema = new [] { new ColumnSchemaProperty {
                             ColumnName = "columnName",
                             ColumnTypes = new [] { "columnTypes" }
                         } }
                     },
                     Type = "type"
                 } },

                 // the properties below are optional
                 Description = "description",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

Description

The description of the training dataset.

public string? Description { get; set; }

Property Value

string

Remarks

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.

public string Name { get; set; }

Property Value

string

Remarks

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

RoleArn

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.

public string RoleArn { get; set; }

Property Value

string

Remarks

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.

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

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

The following basic restrictions apply to tags:

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.

TrainingData

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

public object TrainingData { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnTrainingDataset.IDatasetProperty)[]

Implements

ICfnTrainingDatasetProps