aws-cdk-lib.aws_sagemaker.CfnModelPackage.InferenceSpecificationProperty

InferenceSpecificationProperty Struct

Defines how to perform inference generation after a training job is run.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// 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';

declare const modelInput: any;
const inferenceSpecificationProperty: sagemaker.CfnModelPackage.InferenceSpecificationProperty = {
  containers: [{
    image: 'image',

    // the properties below are optional
    containerHostname: 'containerHostname',
    environment: {
      environmentKey: 'environment',
    },
    framework: 'framework',
    frameworkVersion: 'frameworkVersion',
    imageDigest: 'imageDigest',
    modelDataSource: {
      s3DataSource: {
        compressionType: 'compressionType',
        s3DataType: 's3DataType',
        s3Uri: 's3Uri',

        // the properties below are optional
        modelAccessConfig: {
          acceptEula: false,
        },
      },
    },
    modelDataUrl: 'modelDataUrl',
    modelInput: modelInput,
    nearestModelName: 'nearestModelName',
  }],
  supportedContentTypes: ['supportedContentTypes'],
  supportedResponseMimeTypes: ['supportedResponseMimeTypes'],

  // the properties below are optional
  supportedRealtimeInferenceInstanceTypes: ['supportedRealtimeInferenceInstanceTypes'],
  supportedTransformInstanceTypes: ['supportedTransformInstanceTypes'],
};

# 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

# model_input: Any

inference_specification_property = sagemaker.CfnModelPackage.InferenceSpecificationProperty(
    containers=[sagemaker.CfnModelPackage.ModelPackageContainerDefinitionProperty(
        image="image",

        # the properties below are optional
        container_hostname="containerHostname",
        environment={
            "environment_key": "environment"
        },
        framework="framework",
        framework_version="frameworkVersion",
        image_digest="imageDigest",
        model_data_source=sagemaker.CfnModelPackage.ModelDataSourceProperty(
            s3_data_source=sagemaker.CfnModelPackage.S3ModelDataSourceProperty(
                compression_type="compressionType",
                s3_data_type="s3DataType",
                s3_uri="s3Uri",

                # the properties below are optional
                model_access_config=sagemaker.CfnModelPackage.ModelAccessConfigProperty(
                    accept_eula=False
                )
            )
        ),
        model_data_url="modelDataUrl",
        model_input=model_input,
        nearest_model_name="nearestModelName"
    )],
    supported_content_types=["supportedContentTypes"],
    supported_response_mime_types=["supportedResponseMimeTypes"],

    # the properties below are optional
    supported_realtime_inference_instance_types=["supportedRealtimeInferenceInstanceTypes"],
    supported_transform_instance_types=["supportedTransformInstanceTypes"]
)

// 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.*;

Object modelInput;

InferenceSpecificationProperty inferenceSpecificationProperty = InferenceSpecificationProperty.builder()
        .containers(List.of(ModelPackageContainerDefinitionProperty.builder()
                .image("image")

                // the properties below are optional
                .containerHostname("containerHostname")
                .environment(Map.of(
                        "environmentKey", "environment"))
                .framework("framework")
                .frameworkVersion("frameworkVersion")
                .imageDigest("imageDigest")
                .modelDataSource(ModelDataSourceProperty.builder()
                        .s3DataSource(S3ModelDataSourceProperty.builder()
                                .compressionType("compressionType")
                                .s3DataType("s3DataType")
                                .s3Uri("s3Uri")

                                // the properties below are optional
                                .modelAccessConfig(ModelAccessConfigProperty.builder()
                                        .acceptEula(false)
                                        .build())
                                .build())
                        .build())
                .modelDataUrl("modelDataUrl")
                .modelInput(modelInput)
                .nearestModelName("nearestModelName")
                .build()))
        .supportedContentTypes(List.of("supportedContentTypes"))
        .supportedResponseMimeTypes(List.of("supportedResponseMimeTypes"))

        // the properties below are optional
        .supportedRealtimeInferenceInstanceTypes(List.of("supportedRealtimeInferenceInstanceTypes"))
        .supportedTransformInstanceTypes(List.of("supportedTransformInstanceTypes"))
        .build();

// 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 modelInput;

var inferenceSpecificationProperty = new InferenceSpecificationProperty {
    Containers = new [] { new ModelPackageContainerDefinitionProperty {
        Image = "image",

        // the properties below are optional
        ContainerHostname = "containerHostname",
        Environment = new Dictionary<string, string> {
            { "environmentKey", "environment" }
        },
        Framework = "framework",
        FrameworkVersion = "frameworkVersion",
        ImageDigest = "imageDigest",
        ModelDataSource = new ModelDataSourceProperty {
            S3DataSource = new S3ModelDataSourceProperty {
                CompressionType = "compressionType",
                S3DataType = "s3DataType",
                S3Uri = "s3Uri",

                // the properties below are optional
                ModelAccessConfig = new ModelAccessConfigProperty {
                    AcceptEula = false
                }
            }
        },
        ModelDataUrl = "modelDataUrl",
        ModelInput = modelInput,
        NearestModelName = "nearestModelName"
    } },
    SupportedContentTypes = new [] { "supportedContentTypes" },
    SupportedResponseMimeTypes = new [] { "supportedResponseMimeTypes" },

    // the properties below are optional
    SupportedRealtimeInferenceInstanceTypes = new [] { "supportedRealtimeInferenceInstanceTypes" },
    SupportedTransformInstanceTypes = new [] { "supportedTransformInstanceTypes" }
};

// 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"

var modelInput interface{}

inferenceSpecificationProperty := &InferenceSpecificationProperty{
	Containers: []interface{}{
		&ModelPackageContainerDefinitionProperty{
			Image: jsii.String("image"),

			// the properties below are optional
			ContainerHostname: jsii.String("containerHostname"),
			Environment: map[string]*string{
				"environmentKey": jsii.String("environment"),
			},
			Framework: jsii.String("framework"),
			FrameworkVersion: jsii.String("frameworkVersion"),
			ImageDigest: jsii.String("imageDigest"),
			ModelDataSource: &ModelDataSourceProperty{
				S3DataSource: &S3ModelDataSourceProperty{
					CompressionType: jsii.String("compressionType"),
					S3DataType: jsii.String("s3DataType"),
					S3Uri: jsii.String("s3Uri"),

					// the properties below are optional
					ModelAccessConfig: &ModelAccessConfigProperty{
						AcceptEula: jsii.Boolean(false),
					},
				},
			},
			ModelDataUrl: jsii.String("modelDataUrl"),
			ModelInput: modelInput,
			NearestModelName: jsii.String("nearestModelName"),
		},
	},
	SupportedContentTypes: []*string{
		jsii.String("supportedContentTypes"),
	},
	SupportedResponseMimeTypes: []*string{
		jsii.String("supportedResponseMimeTypes"),
	},

	// the properties below are optional
	SupportedRealtimeInferenceInstanceTypes: []*string{
		jsii.String("supportedRealtimeInferenceInstanceTypes"),
	},
	SupportedTransformInstanceTypes: []*string{
		jsii.String("supportedTransformInstanceTypes"),
	},
}

Properties

containersIResolvable | IResolvable | CfnModelPackage.ModelPackageContainerDefinitionProperty[]containerstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ModelPackageContainerDefinitionProperty]]]containersIResolvableContainersIResolvableContainersinterface{}required#

The Amazon ECR registry path of the Docker image that contains the inference code.

supportedContentTypesstring[]supported_content_typestyping.List[str]supportedContentTypesList<String>SupportedContentTypesstring[]SupportedContentTypes*[]*stringrequired#

The supported MIME types for the input data.

supportedRealtimeInferenceInstanceTypes?optionalstring[]supported_realtime_inference_instance_types?optionaltyping.List[str]supportedRealtimeInferenceInstanceTypes?optionalList<String>SupportedRealtimeInferenceInstanceTypes?optionalstring[]SupportedRealtimeInferenceInstanceTypes?optional*[]*string#

A list of the instance types that are used to generate inferences in real-time.

This parameter is required for unversioned models, and optional for versioned models.

supportedResponseMimeTypesstring[]supported_response_mime_typestyping.List[str]supportedResponseMimeTypesList<String>SupportedResponseMimeTypesstring[]SupportedResponseMimeTypes*[]*stringrequired#

The supported MIME types for the output data.

supportedTransformInstanceTypes?optionalstring[]supported_transform_instance_types?optionaltyping.List[str]supportedTransformInstanceTypes?optionalList<String>SupportedTransformInstanceTypes?optionalstring[]SupportedTransformInstanceTypes?optional*[]*string#

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

This parameter is required for unversioned models, and optional for versioned models.