Package software.amazon.awscdk.services.sagemaker

Interface CfnModelPackage.TransformJobDefinitionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelPackage.TransformJobDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnModelPackage

@Stability(Stable)
public static interface CfnModelPackage.TransformJobDefinitionProperty
extends software.amazon.jsii.JsiiSerializable

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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTransformInput

@Stability(Stable)
@NotNull
Object getTransformInput()

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

Returns union: either IResolvable or CfnModelPackage.TransformInputProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformjobdefinition.html#cfn-sagemaker-modelpackage-transformjobdefinition-transforminput

getTransformOutput

@Stability(Stable)
@NotNull
Object getTransformOutput()

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

Returns union: either IResolvable or CfnModelPackage.TransformOutputProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformjobdefinition.html#cfn-sagemaker-modelpackage-transformjobdefinition-transformoutput

getTransformResources

@Stability(Stable)
@NotNull
Object getTransformResources()

Identifies the ML compute instances for the transform job.

Returns union: either IResolvable or CfnModelPackage.TransformResourcesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformjobdefinition.html#cfn-sagemaker-modelpackage-transformjobdefinition-transformresources

getBatchStrategy

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformjobdefinition.html#cfn-sagemaker-modelpackage-transformjobdefinition-batchstrategy

getEnvironment

@Stability(Stable)
@Nullable
default Object getEnvironment()

The environment variables to set in the Docker container.

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

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformjobdefinition.html#cfn-sagemaker-modelpackage-transformjobdefinition-environment

getMaxConcurrentTransforms

@Stability(Stable)
@Nullable
default Number getMaxConcurrentTransforms()

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

The default value is 1.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformjobdefinition.html#cfn-sagemaker-modelpackage-transformjobdefinition-maxconcurrenttransforms

getMaxPayloadInMb

@Stability(Stable)
@Nullable
default Number getMaxPayloadInMb()

The maximum payload size allowed, in MB.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-transformjobdefinition.html#cfn-sagemaker-modelpackage-transformjobdefinition-maxpayloadinmb

builder

@Stability(Stable)
static CfnModelPackage.TransformJobDefinitionProperty.Builder builder()

Returns:

a CfnModelPackage.TransformJobDefinitionProperty.Builder of CfnModelPackage.TransformJobDefinitionProperty