Package software.amazon.awscdk.services.personalize

Interface CfnDataset.DatasetImportJobProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataset.DatasetImportJobProperty.Jsii$Proxy

Enclosing class:

CfnDataset

@Stability(Stable)
public static interface CfnDataset.DatasetImportJobProperty
extends software.amazon.jsii.JsiiSerializable

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

A dataset import job can be in one of the following states:

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

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

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;
 DatasetImportJobProperty datasetImportJobProperty = DatasetImportJobProperty.builder()
         .datasetArn("datasetArn")
         .datasetImportJobArn("datasetImportJobArn")
         .dataSource(dataSource)
         .jobName("jobName")
         .roleArn("roleArn")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataset.DatasetImportJobProperty.Builder	builder()
default String	getDatasetArn()	The Amazon Resource Name (ARN) of the dataset that receives the imported data.
default String	getDatasetImportJobArn()	The ARN of the dataset import job.
default Object	getDataSource()	The Amazon S3 bucket that contains the training data to import.
default String	getJobName()	The name of the import job.
default String	getRoleArn()	The ARN of the IAM role that has permissions to read from the Amazon S3 data source.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDatasetArn

@Stability(Stable)
@Nullable
default String getDatasetArn()

The Amazon Resource Name (ARN) of the dataset that receives the imported data.

See Also:

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

getDatasetImportJobArn

@Stability(Stable)
@Nullable
default String getDatasetImportJobArn()

The ARN of the dataset import job.

See Also:

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

getDataSource

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

The Amazon S3 bucket that contains the training data to import.

See Also:

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

getJobName

@Stability(Stable)
@Nullable
default String getJobName()

The name of the import job.

See Also:

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

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

The ARN of the IAM role that has permissions to read from the Amazon S3 data source.

See Also:

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

builder

@Stability(Stable)
static CfnDataset.DatasetImportJobProperty.Builder builder()

Returns:

a CfnDataset.DatasetImportJobProperty.Builder of CfnDataset.DatasetImportJobProperty