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

Interface CfnTransformJobMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTransformJobMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-08-10T14:51:26.133Z")
@Stability(Stable)
public interface CfnTransformJobMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnTransformJobPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.sagemaker.*;
 CfnTransformJobMixinProps cfnTransformJobMixinProps = CfnTransformJobMixinProps.builder()
         .batchStrategy("batchStrategy")
         .dataCaptureConfig(DataCaptureConfigProperty.builder()
                 .destinationS3Uri("destinationS3Uri")
                 .generateInferenceId(false)
                 .kmsKeyId("kmsKeyId")
                 .build())
         .dataProcessing(DataProcessingProperty.builder()
                 .inputFilter("inputFilter")
                 .joinSource("joinSource")
                 .outputFilter("outputFilter")
                 .build())
         .environment(Map.of(
                 "environmentKey", "environment"))
         .experimentConfig(ExperimentConfigProperty.builder()
                 .experimentName("experimentName")
                 .trialComponentDisplayName("trialComponentDisplayName")
                 .trialName("trialName")
                 .build())
         .maxConcurrentTransforms(123)
         .maxPayloadInMb(123)
         .modelClientConfig(ModelClientConfigProperty.builder()
                 .invocationsMaxRetries(123)
                 .invocationsTimeoutInSeconds(123)
                 .build())
         .modelName("modelName")
         .tags(List.of(TagsItemsProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .transformInput(TransformInputProperty.builder()
                 .compressionType("compressionType")
                 .contentType("contentType")
                 .dataSource(DataSourceProperty.builder()
                         .s3DataSource(S3DataSourceProperty.builder()
                                 .s3DataType("s3DataType")
                                 .s3Uri("s3Uri")
                                 .build())
                         .build())
                 .splitType("splitType")
                 .build())
         .transformOutput(TransformOutputProperty.builder()
                 .accept("accept")
                 .assembleWith("assembleWith")
                 .kmsKeyId("kmsKeyId")
                 .s3OutputPath("s3OutputPath")
                 .build())
         .transformResources(TransformResourcesProperty.builder()
                 .instanceCount(123)
                 .instanceType("instanceType")
                 .volumeKmsKeyId("volumeKmsKeyId")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-transformjob.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTransformJobMixinProps.Builder	builder()
default String	getBatchStrategy()	Specifies the number of records to include in a mini-batch for an HTTP inference request.
default Object	getDataCaptureConfig()	Configuration to control how SageMaker captures inference data.
default Object	getDataProcessing()	The data structure used to specify the data to be used for inference in a batch transform job.
default Object	getEnvironment()	The environment variables to set in the Docker container.
default Object	getExperimentConfig()	Associates a SageMaker job as a trial component with an experiment and trial.
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 allowed size of the payload, in MB.
default Object	getModelClientConfig()	Configures the timeout and maximum number of retries for processing a transform job invocation.
default String	getModelName()	The name of the model that you want to use for the transform job.
default List<CfnTransformJobPropsMixin.TagsItemsProperty>	getTags()	An array of key-value pairs.
default Object	getTransformInput()	Describes the input source and the way the transform job consumes it.
default Object	getTransformOutput()	Describes the results of the transform job.
default Object	getTransformResources()	Describes the resources, including ML instance types and ML instance count, to use for the transform job.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBatchStrategy

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

Specifies the number of records to include in a mini-batch for an HTTP inference request.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-transformjob.html#cfn-sagemaker-transformjob-batchstrategy

getDataCaptureConfig

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

Configuration to control how SageMaker captures inference data.

Returns union: either IResolvable or CfnTransformJobPropsMixin.DataCaptureConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-transformjob.html#cfn-sagemaker-transformjob-datacaptureconfig

getDataProcessing

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

The data structure used to specify the data to be used for inference in a batch transform job.

Returns union: either IResolvable or CfnTransformJobPropsMixin.DataProcessingProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-transformjob.html#cfn-sagemaker-transformjob-dataprocessing

getEnvironment

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

The environment variables to set in the Docker container.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-transformjob.html#cfn-sagemaker-transformjob-environment

getExperimentConfig

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

Associates a SageMaker job as a trial component with an experiment and trial.

Returns union: either IResolvable or CfnTransformJobPropsMixin.ExperimentConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-transformjob.html#cfn-sagemaker-transformjob-experimentconfig

getMaxConcurrentTransforms

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-transformjob.html#cfn-sagemaker-transformjob-maxconcurrenttransforms

getMaxPayloadInMb

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

The maximum allowed size of the payload, in MB.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-transformjob.html#cfn-sagemaker-transformjob-maxpayloadinmb

getModelClientConfig

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

Configures the timeout and maximum number of retries for processing a transform job invocation.

Returns union: either IResolvable or CfnTransformJobPropsMixin.ModelClientConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-transformjob.html#cfn-sagemaker-transformjob-modelclientconfig

getModelName

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

The name of the model that you want to use for the transform job.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-transformjob.html#cfn-sagemaker-transformjob-modelname

getTags

@Stability(Stable)
@Nullable
default List<CfnTransformJobPropsMixin.TagsItemsProperty> getTags()

An array of key-value pairs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-transformjob.html#cfn-sagemaker-transformjob-tags

getTransformInput

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

Describes the input source and the way the transform job consumes it.

Returns union: either IResolvable or CfnTransformJobPropsMixin.TransformInputProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-transformjob.html#cfn-sagemaker-transformjob-transforminput

getTransformOutput

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

Describes the results of the transform job.

Returns union: either IResolvable or CfnTransformJobPropsMixin.TransformOutputProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-transformjob.html#cfn-sagemaker-transformjob-transformoutput

getTransformResources

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

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

Returns union: either IResolvable or CfnTransformJobPropsMixin.TransformResourcesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-transformjob.html#cfn-sagemaker-transformjob-transformresources

builder

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

Returns:

a CfnTransformJobMixinProps.Builder of CfnTransformJobMixinProps