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, ITaggableV2
Syntax (vb)
Public Class CfnTrainingDataset
Inherits CfnResource
Implements IInspectable, ITaggableV2
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
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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnTrainingDataset(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnTrainingDataset(Construct, String, ICfnTrainingDatasetProps) |
Properties
AttrStatus | The status of the training dataset. |
AttrTrainingDatasetArn | The Amazon Resource Name (ARN) of the training dataset. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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>) |
Constructors
CfnTrainingDataset(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnTrainingDataset(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnTrainingDataset(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnTrainingDataset(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnTrainingDataset(Construct, String, ICfnTrainingDatasetProps)
public CfnTrainingDataset(Construct scope, string id, ICfnTrainingDatasetProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnTrainingDatasetProps
Resource properties.
Properties
AttrStatus
The status of the training dataset.
public virtual string AttrStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Status
AttrTrainingDatasetArn
The Amazon Resource Name (ARN) of the training dataset.
public virtual string AttrTrainingDatasetArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: TrainingDatasetArn
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
The description of the training dataset.
public virtual string Description { get; set; }
Property Value
System.String
Name
The name of the training dataset.
public virtual string Name { get; set; }
Property Value
System.String
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
System.String
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[]
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
System.Object
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>