Package software.amazon.awscdk.cfnpropertymixins.services.personalize

Class CfnDatasetPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.personalize.CfnDatasetPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:20:02.239Z") @Stability(Stable) public class CfnDatasetPropsMixin extends Mixin implements software.constructs.IMixin
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.cfnpropertymixins.services.personalize.*;
 import software.amazon.awscdk.*;
 Object dataSource;
 IMergeStrategy mergeStrategy;
 CfnDatasetPropsMixin cfnDatasetPropsMixin = CfnDatasetPropsMixin.Builder.create(CfnDatasetMixinProps.builder()
         .datasetGroupArn("datasetGroupArn")
         .datasetImportJob(DatasetImportJobProperty.builder()
                 .datasetArn("datasetArn")
                 .datasetImportJobArn("datasetImportJobArn")
                 .dataSource(dataSource)
                 .jobName("jobName")
                 .roleArn("roleArn")
                 .build())
         .datasetType("datasetType")
         .name("name")
         .schemaArn("schemaArn")
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CfnDatasetPropsMixin.Builder
    A fluent builder for CfnDatasetPropsMixin.
    static interface 
    CfnDatasetPropsMixin.DatasetImportJobProperty
    Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset.

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

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IMixin

    software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final List<String>
    CFN_PROPERTY_KEYS
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    CfnDatasetPropsMixin(CfnDatasetMixinProps props)
    Create a mixin to apply properties to AWS::Personalize::Dataset.
     
    CfnDatasetPropsMixin(CfnDatasetMixinProps props, CfnPropertyMixinOptions options)
    Create a mixin to apply properties to AWS::Personalize::Dataset.
    protected
    CfnDatasetPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    CfnDatasetPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    applyTo(software.constructs.IConstruct construct)
    Apply the mixin properties to the construct.
    protected CfnDatasetMixinProps
    getProps()
     
    protected IMergeStrategy
    getStrategy()
     
    Boolean
    supports(software.constructs.IConstruct construct)
    Check if this mixin supports the given construct.

    Methods inherited from class software.amazon.awscdk.Mixin

    isMixin

    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, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnDatasetPropsMixin

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

    • CfnDatasetPropsMixin

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

    • CfnDatasetPropsMixin

      @Stability(Stable) public CfnDatasetPropsMixin(@NotNull CfnDatasetMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::Personalize::Dataset.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnDatasetPropsMixin

      @Stability(Stable) public CfnDatasetPropsMixin(@NotNull CfnDatasetMixinProps props)
      Create a mixin to apply properties to AWS::Personalize::Dataset.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnDatasetMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()