software.amazon.awscdk.services.personalize

Class CfnDataset

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.personalize.CfnDataset

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-02T14:17:16.186Z")
 @Stability(value=Stable)
public class CfnDataset
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Personalize::Dataset`.

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:

• Interactions
• Items
• Users

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:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
• DELETE PENDING > DELETE IN_PROGRESS

To get the status of the dataset, call DescribeDataset .

Related APIs - CreateDatasetGroup

• ListDatasets
• DescribeDataset
• DeleteDataset

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();
 

Nested Class Summary

Nested Classes

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.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDataset(Construct scope, 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)

Method Summary

Modifier and Type	Method and Description
String	getAttrDatasetArn() The Amazon Resource Name (ARN) of the dataset.
protected Map<String,Object>	getCfnProperties()
String	getDatasetGroupArn() The Amazon Resource Name (ARN) of the dataset group.
Object	getDatasetImportJob() Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset.
String	getDatasetType() One of the following values:.
String	getName() The name of the dataset.
String	getSchemaArn() The ARN of the associated schema.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDatasetGroupArn(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(String value) One of the following values:.
void	setName(String value) The name of the dataset.
void	setSchemaArn(String value) The ARN of the associated schema.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDataset

protected CfnDataset(software.amazon.jsii.JsiiObjectRef objRef)

CfnDataset

protected CfnDataset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDataset

@Stability(value=Stable)
public CfnDataset(@NotNull
                                           Construct scope,
                                           @NotNull
                                           String id,
                                           @NotNull
                                           CfnDatasetProps props)

Create a new `AWS::Personalize::Dataset`.

Parameters:

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.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDatasetArn

@Stability(value=Stable)
 @NotNull
public String getAttrDatasetArn()

The Amazon Resource Name (ARN) of the dataset.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDatasetGroupArn

@Stability(value=Stable)
 @NotNull
public String getDatasetGroupArn()

The Amazon Resource Name (ARN) of the dataset group.

setDatasetGroupArn

@Stability(value=Stable)
public void setDatasetGroupArn(@NotNull
                                                        String value)

The Amazon Resource Name (ARN) of the dataset group.

getDatasetType

@Stability(value=Stable)
 @NotNull
public String getDatasetType()

One of the following values:.

• Interactions
• Items
• Users

setDatasetType

@Stability(value=Stable)
public void setDatasetType(@NotNull
                                                    String value)

One of the following values:.

• Interactions
• Items
• Users

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the dataset.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the dataset.

getSchemaArn

@Stability(value=Stable)
 @NotNull
public String getSchemaArn()

The ARN of the associated schema.

setSchemaArn

@Stability(value=Stable)
public void setSchemaArn(@NotNull
                                                  String value)

The ARN of the associated schema.

getDatasetImportJob

@Stability(value=Stable)
 @Nullable
public Object getDatasetImportJob()

Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset.

setDatasetImportJob

@Stability(value=Stable)
public void setDatasetImportJob(@Nullable
                                                         CfnDataset.DatasetImportJobProperty value)

Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset.

setDatasetImportJob

@Stability(value=Stable)
public void setDatasetImportJob(@Nullable
                                                         IResolvable value)

Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset.