Package software.amazon.awscdk.services.stepfunctions.tasks

Interface Channel

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

Channel.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:47.897Z")
@Stability(Stable)
public interface Channel
extends software.amazon.jsii.JsiiSerializable

Describes the training, validation or test dataset and the Amazon S3 location where it is stored.

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.stepfunctions.tasks.*;
 S3Location s3Location;
 Channel channel = Channel.builder()
         .channelName("channelName")
         .dataSource(DataSource.builder()
                 .s3DataSource(S3DataSource.builder()
                         .s3Location(s3Location)
                         // the properties below are optional
                         .attributeNames(List.of("attributeNames"))
                         .s3DataDistributionType(S3DataDistributionType.FULLY_REPLICATED)
                         .s3DataType(S3DataType.MANIFEST_FILE)
                         .build())
                 .build())
         // the properties below are optional
         .compressionType(CompressionType.NONE)
         .contentType("contentType")
         .inputMode(InputMode.PIPE)
         .recordWrapperType(RecordWrapperType.NONE)
         .shuffleConfig(ShuffleConfig.builder()
                 .seed(123)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static Channel.Builder	builder()
String	getChannelName()	Name of the channel.
default CompressionType	getCompressionType()	Compression type if training data is compressed.
default String	getContentType()	The MIME type of the data.
DataSource	getDataSource()	Location of the channel data.
default InputMode	getInputMode()	Input mode to use for the data channel in a training job.
default RecordWrapperType	getRecordWrapperType()	Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format.
default ShuffleConfig	getShuffleConfig()	Shuffle config option for input data in a channel.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getChannelName

@Stability(Stable)
@NotNull
String getChannelName()

Name of the channel.

getDataSource

@Stability(Stable)
@NotNull
DataSource getDataSource()

Location of the channel data.

getCompressionType

@Stability(Stable)
@Nullable
default CompressionType getCompressionType()

Compression type if training data is compressed.

Default: - None

getContentType

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

The MIME type of the data.

Default: - None

getInputMode

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

Input mode to use for the data channel in a training job.

Default: - None

getRecordWrapperType

@Stability(Stable)
@Nullable
default RecordWrapperType getRecordWrapperType()

Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format.

In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute.

Default: - None

getShuffleConfig

@Stability(Stable)
@Nullable
default ShuffleConfig getShuffleConfig()

Shuffle config option for input data in a channel.

Default: - None

builder

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

Returns:

a Channel.Builder of Channel