Package software.amazon.awscdk.services.sagemaker

Interface CfnInferenceComponent.InferenceComponentSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnInferenceComponent.InferenceComponentSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnInferenceComponent

@Stability(Stable)
public static interface CfnInferenceComponent.InferenceComponentSpecificationProperty
extends software.amazon.jsii.JsiiSerializable

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

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.*;
 InferenceComponentSpecificationProperty inferenceComponentSpecificationProperty = InferenceComponentSpecificationProperty.builder()
         .computeResourceRequirements(InferenceComponentComputeResourceRequirementsProperty.builder()
                 .maxMemoryRequiredInMb(123)
                 .minMemoryRequiredInMb(123)
                 .numberOfAcceleratorDevicesRequired(123)
                 .numberOfCpuCoresRequired(123)
                 .build())
         // the properties below are optional
         .container(InferenceComponentContainerSpecificationProperty.builder()
                 .artifactUrl("artifactUrl")
                 .deployedImage(DeployedImageProperty.builder()
                         .resolutionTime("resolutionTime")
                         .resolvedImage("resolvedImage")
                         .specifiedImage("specifiedImage")
                         .build())
                 .environment(Map.of(
                         "environmentKey", "environment"))
                 .image("image")
                 .build())
         .modelName("modelName")
         .startupParameters(InferenceComponentStartupParametersProperty.builder()
                 .containerStartupHealthCheckTimeoutInSeconds(123)
                 .modelDataDownloadTimeoutInSeconds(123)
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnInferenceComponent.InferenceComponentSpecificationProperty.Builder	builder()
Object	getComputeResourceRequirements()	The compute resources allocated to run the model assigned to the inference component.
default Object	getContainer()	Defines a container that provides the runtime environment for a model that you deploy with an inference component.
default String	getModelName()	The name of an existing SageMaker model object in your account that you want to deploy with the inference component.
default Object	getStartupParameters()	Settings that take effect while the model container starts up.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComputeResourceRequirements

@Stability(Stable)
@NotNull
Object getComputeResourceRequirements()

The compute resources allocated to run the model assigned to the inference component.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-computeresourcerequirements

getContainer

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

Defines a container that provides the runtime environment for a model that you deploy with an inference component.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-container

getModelName

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

The name of an existing SageMaker model object in your account that you want to deploy with the inference component.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-modelname

getStartupParameters

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

Settings that take effect while the model container starts up.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-inferencecomponentspecification.html#cfn-sagemaker-inferencecomponent-inferencecomponentspecification-startupparameters

builder

@Stability(Stable)
static CfnInferenceComponent.InferenceComponentSpecificationProperty.Builder builder()

Returns:

a CfnInferenceComponent.InferenceComponentSpecificationProperty.Builder of CfnInferenceComponent.InferenceComponentSpecificationProperty