Package software.amazon.awscdk.services.personalize

Class CfnDataset

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.personalize.CfnDataset
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:10.455Z") @Stability(Stable) 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 5 types of datasets:

  • Item interactions
  • Items
  • Users
  • Action interactions (you can't use CloudFormation to create an Action interactions dataset)
  • Actions (you can't use CloudFormation to create an Actions dataset)

Each dataset type has an associated schema with required field types. Only the Item 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

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

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDataset

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

    • CfnDataset

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

    • CfnDataset

      @Stability(Stable) public CfnDataset(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDatasetProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrDatasetArn()
      The Amazon Resource Name (ARN) of the dataset.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDatasetGroupArn

      @Stability(Stable) @NotNull public String getDatasetGroupArn()
      The Amazon Resource Name (ARN) of the dataset group.

    • setDatasetGroupArn

      @Stability(Stable) public void setDatasetGroupArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the dataset group.

    • getDatasetType

      @Stability(Stable) @NotNull public String getDatasetType()
      One of the following values:.

    • setDatasetType

      @Stability(Stable) public void setDatasetType(@NotNull String value)
      One of the following values:.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the dataset.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the dataset.

    • getSchemaArn

      @Stability(Stable) @NotNull public String getSchemaArn()
      The ARN of the associated schema.

    • setSchemaArn

      @Stability(Stable) public void setSchemaArn(@NotNull String value)
      The ARN of the associated schema.

    • getDatasetImportJob

      @Stability(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(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.

    • setDatasetImportJob

      @Stability(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.