Skip to content
v2.278.0

TransformJobDefinitionProperty Struct ​

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

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const transformJobDefinitionProperty: sagemaker.CfnModelPackage.TransformJobDefinitionProperty = {
  transformInput: {
    dataSource: {
      s3DataSource: {
        s3DataType: 's3DataType',
        s3Uri: 's3Uri',
      },
    },

    // the properties below are optional
    compressionType: 'compressionType',
    contentType: 'contentType',
    splitType: 'splitType',
  },
  transformOutput: {
    s3OutputPath: 's3OutputPath',

    // the properties below are optional
    accept: 'accept',
    assembleWith: 'assembleWith',
    kmsKeyId: 'kmsKeyId',
  },
  transformResources: {
    instanceCount: 123,
    instanceType: 'instanceType',

    // the properties below are optional
    volumeKmsKeyId: 'volumeKmsKeyId',
  },

  // the properties below are optional
  batchStrategy: 'batchStrategy',
  environment: {
    environmentKey: 'environment',
  },
  maxConcurrentTransforms: 123,
  maxPayloadInMb: 123,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

transform_job_definition_property = sagemaker.CfnModelPackage.TransformJobDefinitionProperty(
    transform_input=sagemaker.CfnModelPackage.TransformInputProperty(
        data_source=sagemaker.CfnModelPackage.DataSourceProperty(
            s3_data_source=sagemaker.CfnModelPackage.S3DataSourceProperty(
                s3_data_type="s3DataType",
                s3_uri="s3Uri"
            )
        ),

        # the properties below are optional
        compression_type="compressionType",
        content_type="contentType",
        split_type="splitType"
    ),
    transform_output=sagemaker.CfnModelPackage.TransformOutputProperty(
        s3_output_path="s3OutputPath",

        # the properties below are optional
        accept="accept",
        assemble_with="assembleWith",
        kms_key_id="kmsKeyId"
    ),
    transform_resources=sagemaker.CfnModelPackage.TransformResourcesProperty(
        instance_count=123,
        instance_type="instanceType",

        # the properties below are optional
        volume_kms_key_id="volumeKmsKeyId"
    ),

    # the properties below are optional
    batch_strategy="batchStrategy",
    environment={
        "environment_key": "environment"
    },
    max_concurrent_transforms=123,
    max_payload_in_mb=123
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;

var transformJobDefinitionProperty = new TransformJobDefinitionProperty {
    TransformInput = new TransformInputProperty {
        DataSource = new DataSourceProperty {
            S3DataSource = new S3DataSourceProperty {
                S3DataType = "s3DataType",
                S3Uri = "s3Uri"
            }
        },

        // the properties below are optional
        CompressionType = "compressionType",
        ContentType = "contentType",
        SplitType = "splitType"
    },
    TransformOutput = new TransformOutputProperty {
        S3OutputPath = "s3OutputPath",

        // the properties below are optional
        Accept = "accept",
        AssembleWith = "assembleWith",
        KmsKeyId = "kmsKeyId"
    },
    TransformResources = new TransformResourcesProperty {
        InstanceCount = 123,
        InstanceType = "instanceType",

        // the properties below are optional
        VolumeKmsKeyId = "volumeKmsKeyId"
    },

    // the properties below are optional
    BatchStrategy = "batchStrategy",
    Environment = new Dictionary<string, string> {
        { "environmentKey", "environment" }
    },
    MaxConcurrentTransforms = 123,
    MaxPayloadInMb = 123
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

transformJobDefinitionProperty := &TransformJobDefinitionProperty{
	TransformInput: &TransformInputProperty{
		DataSource: &DataSourceProperty{
			S3DataSource: &S3DataSourceProperty{
				S3DataType: jsii.String("s3DataType"),
				S3Uri: jsii.String("s3Uri"),
			},
		},

		// the properties below are optional
		CompressionType: jsii.String("compressionType"),
		ContentType: jsii.String("contentType"),
		SplitType: jsii.String("splitType"),
	},
	TransformOutput: &TransformOutputProperty{
		S3OutputPath: jsii.String("s3OutputPath"),

		// the properties below are optional
		Accept: jsii.String("accept"),
		AssembleWith: jsii.String("assembleWith"),
		KmsKeyId: jsii.String("kmsKeyId"),
	},
	TransformResources: &TransformResourcesProperty{
		InstanceCount: jsii.Number(123),
		InstanceType: jsii.String("instanceType"),

		// the properties below are optional
		VolumeKmsKeyId: jsii.String("volumeKmsKeyId"),
	},

	// the properties below are optional
	BatchStrategy: jsii.String("batchStrategy"),
	Environment: map[string]*string{
		"environmentKey": jsii.String("environment"),
	},
	MaxConcurrentTransforms: jsii.Number(123),
	MaxPayloadInMb: jsii.Number(123),
}

Properties ​

batchStrategyoptionalstringbatch_strategyoptionalstrbatchStrategyoptionalStringBatchStrategyoptionalstringBatchStrategyoptional*string #
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.

environmentoptionalIResolvable | { [key: string]: string }environmentoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]environmentoptionalIResolvableEnvironmentoptionalIResolvableEnvironmentoptionalinterface{} #
The environment variables to set in the Docker container.

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

maxConcurrentTransformsoptionalnumbermax_concurrent_transformsoptionalint | floatmaxConcurrentTransformsoptionalNumberMaxConcurrentTransformsoptionaldoubleMaxConcurrentTransformsoptional*float64 #
The maximum number of parallel requests that can be sent to each instance in a transform job.

The default value is 1.

maxPayloadInMboptionalnumbermax_payload_in_mboptionalint | floatmaxPayloadInMboptionalNumberMaxPayloadInMboptionaldoubleMaxPayloadInMboptional*float64 #
The maximum payload size allowed, in MB.

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

transformInputIResolvable | CfnModelPackage.TransformInputPropertytransform_inputtyping.Union[IResolvable, TransformInputProperty]transformInputIResolvableTransformInputIResolvableTransformInputinterface{} required #
A description of the input source and the way the transform job consumes it.
transformOutputIResolvable | CfnModelPackage.TransformOutputPropertytransform_outputtyping.Union[IResolvable, TransformOutputProperty]transformOutputIResolvableTransformOutputIResolvableTransformOutputinterface{} required #
Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
transformResourcesIResolvable | CfnModelPackage.TransformResourcesPropertytransform_resourcestyping.Union[IResolvable, TransformResourcesProperty]transformResourcesIResolvableTransformResourcesIResolvableTransformResourcesinterface{} required #
Identifies the ML compute instances for the transform job.