aws-cdk-lib.aws_stepfunctions_tasks.Channel

interface Channel

LanguageType name
.NETAmazon.CDK.AWS.StepFunctions.Tasks.Channel
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#Channel
Javasoftware.amazon.awscdk.services.stepfunctions.tasks.Channel
Pythonaws_cdk.aws_stepfunctions_tasks.Channel
TypeScript (source)aws-cdk-lib » aws_stepfunctions_tasks » Channel

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 { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';

declare const s3Location: stepfunctions_tasks.S3Location;
const channel: stepfunctions_tasks.Channel = {
  channelName: 'channelName',
  dataSource: {
    s3DataSource: {
      s3Location: s3Location,

      // the properties below are optional
      attributeNames: ['attributeNames'],
      s3DataDistributionType: stepfunctions_tasks.S3DataDistributionType.FULLY_REPLICATED,
      s3DataType: stepfunctions_tasks.S3DataType.MANIFEST_FILE,
    },
  },

  // the properties below are optional
  compressionType: stepfunctions_tasks.CompressionType.NONE,
  contentType: 'contentType',
  inputMode: stepfunctions_tasks.InputMode.PIPE,
  recordWrapperType: stepfunctions_tasks.RecordWrapperType.NONE,
  shuffleConfig: {
    seed: 123,
  },
};

Properties

NameTypeDescription
channelNamestringName of the channel.
dataSourceDataSourceLocation of the channel data.
compressionType?CompressionTypeCompression type if training data is compressed.
contentType?stringThe MIME type of the data.
inputMode?InputModeInput mode to use for the data channel in a training job.
recordWrapperType?RecordWrapperTypeSpecify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format.
shuffleConfig?ShuffleConfigShuffle config option for input data in a channel.

channelName

Type: string

Name of the channel.


dataSource

Type: DataSource

Location of the channel data.


compressionType?

Type: CompressionType (optional, default: None)

Compression type if training data is compressed.


contentType?

Type: string (optional, default: None)

The MIME type of the data.


inputMode?

Type: InputMode (optional, default: None)

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


recordWrapperType?

Type: RecordWrapperType (optional, default: None)

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.


shuffleConfig?

Type: ShuffleConfig (optional, default: None)

Shuffle config option for input data in a channel.