Package software.amazon.awscdk.services.sagemaker

Interface CfnProcessingJob.S3InputProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProcessingJob.S3InputProperty.Jsii$Proxy

Enclosing class:

CfnProcessingJob

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

Configuration for downloading input data from Amazon S3 into the processing container.

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.*;
 S3InputProperty s3InputProperty = S3InputProperty.builder()
         .s3DataType("s3DataType")
         .s3Uri("s3Uri")
         // the properties below are optional
         .localPath("localPath")
         .s3CompressionType("s3CompressionType")
         .s3DataDistributionType("s3DataDistributionType")
         .s3InputMode("s3InputMode")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnProcessingJob.S3InputProperty.Builder	builder()
default String	getLocalPath()	The local path in your container where you want Amazon SageMaker to write input data to.
default String	getS3CompressionType()	Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container.
default String	getS3DataDistributionType()	Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated , or whether the data from Amazon S3 is sharded by Amazon S3 key, downloading one shard of data to each processing instance.
String	getS3DataType()	Whether you use an S3Prefix or a ManifestFile for the data type.
default String	getS3InputMode()	Whether to use File or Pipe input mode.
String	getS3Uri()	The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getS3DataType

@Stability(Stable)
@NotNull
String getS3DataType()

Whether you use an S3Prefix or a ManifestFile for the data type.

If you choose S3Prefix , S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose ManifestFile , S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.

See Also:

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

getS3Uri

@Stability(Stable)
@NotNull
String getS3Uri()

The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.

See Also:

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

getLocalPath

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

The local path in your container where you want Amazon SageMaker to write input data to.

LocalPath is an absolute path to the input data and must begin with /opt/ml/processing/ . LocalPath is a required parameter when AppManaged is False (default).

See Also:

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

getS3CompressionType

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

Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container.

Gzip can only be used when Pipe mode is specified as the S3InputMode . In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.

See Also:

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

getS3DataDistributionType

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

Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated , or whether the data from Amazon S3 is sharded by Amazon S3 key, downloading one shard of data to each processing instance.

See Also:

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

getS3InputMode

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

Whether to use File or Pipe input mode.

In File mode, Amazon SageMaker copies the data from the input source onto the local ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.

See Also:

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

builder

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

Returns:

a CfnProcessingJob.S3InputProperty.Builder of CfnProcessingJob.S3InputProperty