@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:49.452Z") public class CfnDataset extends CfnResource implements IInspectable
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
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.personalize.*; Object dataSource; CfnDataset cfnDataset = CfnDataset.Builder.create(this, "MyCfnDataset") .datasetGroupArn("datasetGroupArn") .datasetType("datasetType") .name("name") .schemaArn("schemaArn") // the properties below are optional .datasetImportJob(DatasetImportJobProperty.builder() .datasetArn("datasetArn") .datasetImportJobArn("datasetImportJobArn") .dataSource(dataSource) .jobName("jobName") .roleArn("roleArn") .build()) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnDataset.Builder
A fluent builder for
CfnDataset . |
static interface |
CfnDataset.DatasetImportJobProperty
Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset.
|
static interface |
CfnDataset.DataSourceProperty
Describes the data source that contains the data to upload to a dataset.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnDataset(Construct scope,
java.lang.String id,
CfnDatasetProps props)
Create a new `AWS::Personalize::Dataset`.
|
protected |
CfnDataset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnDataset(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrDatasetArn()
The Amazon Resource Name (ARN) of the dataset.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDatasetGroupArn()
The Amazon Resource Name (ARN) of the dataset group.
|
java.lang.Object |
getDatasetImportJob()
Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset.
|
java.lang.String |
getDatasetType()
One of the following values:.
|
java.lang.String |
getName()
The name of the dataset.
|
java.lang.String |
getSchemaArn()
The ARN of the associated schema.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setDatasetGroupArn(java.lang.String value)
The Amazon Resource Name (ARN) of the dataset group.
|
void |
setDatasetImportJob(CfnDataset.DatasetImportJobProperty value)
Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset.
|
void |
setDatasetImportJob(IResolvable value)
Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset.
|
void |
setDatasetType(java.lang.String value)
One of the following values:.
|
void |
setName(java.lang.String value)
The name of the dataset.
|
void |
setSchemaArn(java.lang.String value)
The ARN of the associated schema.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnDataset(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnDataset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnDataset(Construct scope, java.lang.String id, CfnDatasetProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrDatasetArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getDatasetGroupArn()
public void setDatasetGroupArn(java.lang.String value)
public java.lang.String getDatasetType()
public void setDatasetType(java.lang.String value)
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.String getSchemaArn()
public void setSchemaArn(java.lang.String value)
public java.lang.Object getDatasetImportJob()
public void setDatasetImportJob(CfnDataset.DatasetImportJobProperty value)
public void setDatasetImportJob(IResolvable value)