Package software.amazon.awscdk.services.personalize

Interface CfnDatasetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDatasetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:46.317Z")
@Stability(Stable)
public interface CfnDatasetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDataset.

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;
 CfnDatasetProps cfnDatasetProps = CfnDatasetProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-dataset.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDatasetProps.Builder	A builder for CfnDatasetProps
static final class	CfnDatasetProps.Jsii$Proxy	An implementation for CfnDatasetProps

Method Summary

Modifier and Type	Method	Description
static CfnDatasetProps.Builder	builder()
String	getDatasetGroupArn()	The Amazon Resource Name (ARN) of the dataset group.
default 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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDatasetGroupArn

@Stability(Stable)
@NotNull
String getDatasetGroupArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-dataset.html#cfn-personalize-dataset-datasetgrouparn

getDatasetType

@Stability(Stable)
@NotNull
String getDatasetType()

One of the following values:.

• Interactions
• Items
• Users

You can't use CloudFormation to create an Action Interactions or Actions dataset.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-dataset.html#cfn-personalize-dataset-datasettype

getName

@Stability(Stable)
@NotNull
String getName()

The name of the dataset.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-dataset.html#cfn-personalize-dataset-name

getSchemaArn

@Stability(Stable)
@NotNull
String getSchemaArn()

The ARN of the associated schema.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-dataset.html#cfn-personalize-dataset-schemaarn

getDatasetImportJob

@Stability(Stable)
@Nullable
default Object getDatasetImportJob()

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

If you specify a dataset import job as part of a dataset, all dataset import job fields are required.

Returns union: either IResolvable or CfnDataset.DatasetImportJobProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-dataset.html#cfn-personalize-dataset-datasetimportjob

builder

@Stability(Stable)
static CfnDatasetProps.Builder builder()

Returns:

a CfnDatasetProps.Builder of CfnDatasetProps