Package 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:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.706Z") @Stability(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

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

  • 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 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 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:.

      • Interactions
      • Items
      • Users

    • setDatasetType

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

      • Interactions
      • Items
      • Users

    • 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 CfnDataset.DatasetImportJobProperty 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 IResolvable value)
      Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset.