Class CfnDataset
A CloudFormation AWS::Personalize::Dataset
.
Inherited Members
Namespace: Amazon.CDK.AWS.Personalize
Assembly: Amazon.CDK.AWS.Personalize.dll
Syntax (csharp)
public class CfnDataset : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDataset
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset.
There are three types of datasets:
Each dataset type has an associated schema with required field types. Only the Interactions
dataset is required in order to train a model (also referred to as creating a solution).
A dataset can be in one of the following states:
To get the status of the dataset, call DescribeDataset .
Related APIs - CreateDatasetGroup
CloudformationResource: AWS::Personalize::Dataset
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-dataset.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.Personalize;
var dataSource;
var cfnDataset = new CfnDataset(this, "MyCfnDataset", new CfnDatasetProps {
DatasetGroupArn = "datasetGroupArn",
DatasetType = "datasetType",
Name = "name",
SchemaArn = "schemaArn",
// the properties below are optional
DatasetImportJob = new DatasetImportJobProperty {
DatasetArn = "datasetArn",
DatasetImportJobArn = "datasetImportJobArn",
DataSource = dataSource,
JobName = "jobName",
RoleArn = "roleArn"
}
});
Synopsis
Constructors
CfnDataset(Construct, String, ICfnDatasetProps) | Create a new |
CfnDataset(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDataset(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrDatasetArn | The Amazon Resource Name (ARN) of the dataset. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DatasetGroupArn | The Amazon Resource Name (ARN) of the dataset group. |
DatasetImportJob | Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. |
DatasetType | One of the following values:. |
Name | The name of the dataset. |
SchemaArn | The ARN of the associated schema. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDataset(Construct, String, ICfnDatasetProps)
Create a new AWS::Personalize::Dataset
.
public CfnDataset(Construct scope, string id, ICfnDatasetProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnDatasetProps
- resource properties.
CfnDataset(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDataset(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDataset(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDataset(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrDatasetArn
The Amazon Resource Name (ARN) of the dataset.
public virtual string AttrDatasetArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DatasetArn
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
DatasetGroupArn
The Amazon Resource Name (ARN) of the dataset group.
public virtual string DatasetGroupArn { get; set; }
Property Value
System.String
Remarks
DatasetImportJob
Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset.
public virtual object DatasetImportJob { get; set; }
Property Value
System.Object
Remarks
DatasetType
One of the following values:.
public virtual string DatasetType { get; set; }
Property Value
System.String
Remarks
Name
The name of the dataset.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
SchemaArn
The ARN of the associated schema.
public virtual string SchemaArn { get; set; }
Property Value
System.String
Remarks
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>