software.amazon.awscdk.services.sagemaker

Interface CfnModelPackage.TransformJobDefinitionProperty

All Known Implementing Classes:

CfnModelPackage.TransformJobDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnModelPackage

public static interface CfnModelPackage.TransformJobDefinitionProperty

Defines the input needed to run a transform job using the inference specification specified in the algorithm.

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.*;
 TransformJobDefinitionProperty transformJobDefinitionProperty = TransformJobDefinitionProperty.builder()
         .transformInput(TransformInputProperty.builder()
                 .dataSource(DataSourceProperty.builder()
                         .s3DataSource(S3DataSourceProperty.builder()
                                 .s3DataType("s3DataType")
                                 .s3Uri("s3Uri")
                                 .build())
                         .build())
                 // the properties below are optional
                 .compressionType("compressionType")
                 .contentType("contentType")
                 .splitType("splitType")
                 .build())
         .transformOutput(TransformOutputProperty.builder()
                 .s3OutputPath("s3OutputPath")
                 // the properties below are optional
                 .accept("accept")
                 .assembleWith("assembleWith")
                 .kmsKeyId("kmsKeyId")
                 .build())
         .transformResources(TransformResourcesProperty.builder()
                 .instanceCount(123)
                 .instanceType("instanceType")
                 // the properties below are optional
                 .volumeKmsKeyId("volumeKmsKeyId")
                 .build())
         // the properties below are optional
         .batchStrategy("batchStrategy")
         .environment(Map.of(
                 "environmentKey", "environment"))
         .maxConcurrentTransforms(123)
         .maxPayloadInMb(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnModelPackage.TransformJobDefinitionProperty.Builder	builder()
default java.lang.String	getBatchStrategy() A string that determines the number of records included in a single mini-batch.
default java.lang.Object	getEnvironment() The environment variables to set in the Docker container.
default java.lang.Number	getMaxConcurrentTransforms() The maximum number of parallel requests that can be sent to each instance in a transform job.
default java.lang.Number	getMaxPayloadInMb() The maximum payload size allowed, in MB.
java.lang.Object	getTransformInput() A description of the input source and the way the transform job consumes it.
java.lang.Object	getTransformOutput() Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
java.lang.Object	getTransformResources() Identifies the ML compute instances for the transform job.

Method Detail

getTransformInput

java.lang.Object getTransformInput()

A description of the input source and the way the transform job consumes it.

getTransformOutput

java.lang.Object getTransformOutput()

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

getTransformResources

java.lang.Object getTransformResources()

Identifies the ML compute instances for the transform job.

getBatchStrategy

default java.lang.String getBatchStrategy()

A string that determines the number of records included in a single mini-batch.

SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit.

getEnvironment

default java.lang.Object getEnvironment()

The environment variables to set in the Docker container.

We support up to 16 key and values entries in the map.

getMaxConcurrentTransforms

default java.lang.Number getMaxConcurrentTransforms()

The maximum number of parallel requests that can be sent to each instance in a transform job.

The default value is 1.

getMaxPayloadInMb

default java.lang.Number getMaxPayloadInMb()

The maximum payload size allowed, in MB.

A payload is the data portion of a record (without metadata).

builder

static CfnModelPackage.TransformJobDefinitionProperty.Builder builder()

Returns:

a CfnModelPackage.TransformJobDefinitionProperty.Builder of CfnModelPackage.TransformJobDefinitionProperty