Class CfnTrainingDataset
Defines the information necessary to create a training dataset.
Inherited Members
Namespace: Amazon.CDK.AwsCleanroomsml
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnTrainingDataset : CfnResource, IInspectable, ITaggableV2Syntax (vb)
Public Class CfnTrainingDataset Inherits CfnResource Implements IInspectable, ITaggableV2Remarks
In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.
CloudformationResource: AWS::CleanRoomsML::TrainingDataset
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 cfnTrainingDataset = new CfnTrainingDataset(this, "MyCfnTrainingDataset", 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
| CfnTrainingDataset(Construct, string, ICfnTrainingDatasetProps) | Defines the information necessary to create a training dataset. |
Properties
| AttrStatus | The status of the training dataset. |
| AttrTrainingDatasetArn | The Amazon Resource Name (ARN) of the training dataset. |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CdkTagManager | Tag Manager which manages the tags for this resource. |
| CfnProperties | Defines the information necessary to create a training dataset. |
| 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 |
| 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. |
Methods
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| RenderProperties(IDictionary<string, object>) | Defines the information necessary to create a training dataset. |
Constructors
CfnTrainingDataset(Construct, string, ICfnTrainingDatasetProps)
Defines the information necessary to create a training dataset.
public CfnTrainingDataset(Construct scope, string id, ICfnTrainingDatasetProps props)Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnTrainingDatasetProps
Resource properties.
Remarks
In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.
CloudformationResource: AWS::CleanRoomsML::TrainingDataset
ExampleMetadata: fixture=_generated
Properties
AttrStatus
The status of the training dataset.
public virtual string AttrStatus { get; }Property Value
Remarks
CloudformationAttribute: Status
AttrTrainingDatasetArn
The Amazon Resource Name (ARN) of the training dataset.
public virtual string AttrTrainingDatasetArn { get; }Property Value
Remarks
CloudformationAttribute: TrainingDatasetArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }Property Value
Remarks
In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.
CloudformationResource: AWS::CleanRoomsML::TrainingDataset
ExampleMetadata: fixture=_generated
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }Property Value
Remarks
In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.
CloudformationResource: AWS::CleanRoomsML::TrainingDataset
ExampleMetadata: fixture=_generated
CfnProperties
Defines the information necessary to create a training dataset.
protected override IDictionary<string, object> CfnProperties { get; }Property Value
Overrides
Remarks
In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.
CloudformationResource: AWS::CleanRoomsML::TrainingDataset
ExampleMetadata: fixture=_generated
Description
The description of the training dataset.
public virtual string? Description { get; set; }Property Value
Remarks
In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.
CloudformationResource: AWS::CleanRoomsML::TrainingDataset
ExampleMetadata: fixture=_generated
Name
The name of the training dataset.
public virtual string Name { get; set; }Property Value
Remarks
In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.
CloudformationResource: AWS::CleanRoomsML::TrainingDataset
ExampleMetadata: fixture=_generated
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 virtual string RoleArn { get; set; }Property Value
Remarks
In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.
CloudformationResource: AWS::CleanRoomsML::TrainingDataset
ExampleMetadata: fixture=_generated
Tags
The optional metadata that you apply to the resource to help you categorize and organize them.
public virtual ICfnTag[]? Tags { get; set; }Property Value
ICfnTag[]
Remarks
In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.
CloudformationResource: AWS::CleanRoomsML::TrainingDataset
ExampleMetadata: fixture=_generated
TrainingData
An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema.
public virtual object TrainingData { get; set; }Property Value
Remarks
In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.
CloudformationResource: AWS::CleanRoomsML::TrainingDataset
ExampleMetadata: fixture=_generated
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
Remarks
In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.
CloudformationResource: AWS::CleanRoomsML::TrainingDataset
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
Defines the information necessary to create a training dataset.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.
CloudformationResource: AWS::CleanRoomsML::TrainingDataset
ExampleMetadata: fixture=_generated