Package software.amazon.awscdk.services.sagemaker

Interface CfnProcessingJob.DatasetDefinitionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProcessingJob.DatasetDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnProcessingJob

@Stability(Stable)
public static interface CfnProcessingJob.DatasetDefinitionProperty
extends software.amazon.jsii.JsiiSerializable

Configuration for Dataset Definition inputs.

The Dataset Definition input must specify exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition types.

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.sagemaker.*;
 DatasetDefinitionProperty datasetDefinitionProperty = DatasetDefinitionProperty.builder()
         .athenaDatasetDefinition(AthenaDatasetDefinitionProperty.builder()
                 .catalog("catalog")
                 .database("database")
                 .outputFormat("outputFormat")
                 .outputS3Uri("outputS3Uri")
                 .queryString("queryString")
                 // the properties below are optional
                 .kmsKeyId("kmsKeyId")
                 .outputCompression("outputCompression")
                 .workGroup("workGroup")
                 .build())
         .dataDistributionType("dataDistributionType")
         .inputMode("inputMode")
         .localPath("localPath")
         .redshiftDatasetDefinition(RedshiftDatasetDefinitionProperty.builder()
                 .clusterId("clusterId")
                 .clusterRoleArn("clusterRoleArn")
                 .database("database")
                 .dbUser("dbUser")
                 .outputFormat("outputFormat")
                 .outputS3Uri("outputS3Uri")
                 .queryString("queryString")
                 // the properties below are optional
                 .kmsKeyId("kmsKeyId")
                 .outputCompression("outputCompression")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-datasetdefinition.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnProcessingJob.DatasetDefinitionProperty.Builder	builder()
default Object	getAthenaDatasetDefinition()	Configuration for Athena Dataset Definition input.
default String	getDataDistributionType()	Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).
default String	getInputMode()	Whether to use File or Pipe input mode.
default String	getLocalPath()	The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a processing job.
default Object	getRedshiftDatasetDefinition()	Configuration for Redshift Dataset Definition input.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAthenaDatasetDefinition

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

Configuration for Athena Dataset Definition input.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-datasetdefinition.html#cfn-sagemaker-processingjob-datasetdefinition-athenadatasetdefinition

getDataDistributionType

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

Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-datasetdefinition.html#cfn-sagemaker-processingjob-datasetdefinition-datadistributiontype

getInputMode

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

Whether to use File or Pipe input mode.

In File (default) mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-datasetdefinition.html#cfn-sagemaker-processingjob-datasetdefinition-inputmode

getLocalPath

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

The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a processing job.

LocalPath is an absolute path to the input data. This is a required parameter when AppManaged is False (default).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-datasetdefinition.html#cfn-sagemaker-processingjob-datasetdefinition-localpath

getRedshiftDatasetDefinition

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

Configuration for Redshift Dataset Definition input.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-datasetdefinition.html#cfn-sagemaker-processingjob-datasetdefinition-redshiftdatasetdefinition

builder

@Stability(Stable)
static CfnProcessingJob.DatasetDefinitionProperty.Builder builder()

Returns:

a CfnProcessingJob.DatasetDefinitionProperty.Builder of CfnProcessingJob.DatasetDefinitionProperty