Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Class CfnProcessingJobPropsMixin.S3InputProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnProcessingJobPropsMixin.S3InputProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnProcessingJobPropsMixin.S3InputProperty>

Enclosing interface:

CfnProcessingJobPropsMixin.S3InputProperty

@Stability(Stable)
public static final class CfnProcessingJobPropsMixin.S3InputProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnProcessingJobPropsMixin.S3InputProperty>

A builder for CfnProcessingJobPropsMixin.S3InputProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnProcessingJobPropsMixin.S3InputProperty	build()	Builds the configured instance.
CfnProcessingJobPropsMixin.S3InputProperty.Builder	localPath(String localPath)	Sets the value of CfnProcessingJobPropsMixin.S3InputProperty.getLocalPath()
CfnProcessingJobPropsMixin.S3InputProperty.Builder	s3CompressionType(String s3CompressionType)	Sets the value of CfnProcessingJobPropsMixin.S3InputProperty.getS3CompressionType()
CfnProcessingJobPropsMixin.S3InputProperty.Builder	s3DataDistributionType(String s3DataDistributionType)	Sets the value of CfnProcessingJobPropsMixin.S3InputProperty.getS3DataDistributionType()
CfnProcessingJobPropsMixin.S3InputProperty.Builder	s3DataType(String s3DataType)	Sets the value of CfnProcessingJobPropsMixin.S3InputProperty.getS3DataType()
CfnProcessingJobPropsMixin.S3InputProperty.Builder	s3InputMode(String s3InputMode)	Sets the value of CfnProcessingJobPropsMixin.S3InputProperty.getS3InputMode()
CfnProcessingJobPropsMixin.S3InputProperty.Builder	s3Uri(String s3Uri)	Sets the value of CfnProcessingJobPropsMixin.S3InputProperty.getS3Uri()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

localPath

@Stability(Stable)
public CfnProcessingJobPropsMixin.S3InputProperty.Builder localPath(String localPath)

Sets the value of CfnProcessingJobPropsMixin.S3InputProperty.getLocalPath()

Parameters:

localPath - 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).

Returns:

this

s3CompressionType

@Stability(Stable)
public CfnProcessingJobPropsMixin.S3InputProperty.Builder s3CompressionType(String s3CompressionType)

Sets the value of CfnProcessingJobPropsMixin.S3InputProperty.getS3CompressionType()

Parameters:

s3CompressionType - 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.

Returns:

this

s3DataDistributionType

@Stability(Stable)
public CfnProcessingJobPropsMixin.S3InputProperty.Builder s3DataDistributionType(String s3DataDistributionType)

Sets the value of CfnProcessingJobPropsMixin.S3InputProperty.getS3DataDistributionType()

Parameters:

s3DataDistributionType - 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.

Returns:

this

s3DataType

@Stability(Stable)
public CfnProcessingJobPropsMixin.S3InputProperty.Builder s3DataType(String s3DataType)

Sets the value of CfnProcessingJobPropsMixin.S3InputProperty.getS3DataType()

Parameters:

s3DataType - 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.

Returns:

this

s3InputMode

@Stability(Stable)
public CfnProcessingJobPropsMixin.S3InputProperty.Builder s3InputMode(String s3InputMode)

Sets the value of CfnProcessingJobPropsMixin.S3InputProperty.getS3InputMode()

Parameters:

s3InputMode - 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.

Returns:

this

s3Uri

@Stability(Stable)
public CfnProcessingJobPropsMixin.S3InputProperty.Builder s3Uri(String s3Uri)

Sets the value of CfnProcessingJobPropsMixin.S3InputProperty.getS3Uri()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnProcessingJobPropsMixin.S3InputProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnProcessingJobPropsMixin.S3InputProperty>

Returns:

a new instance of CfnProcessingJobPropsMixin.S3InputProperty

Throws:

NullPointerException - if any required attribute was not provided