software.amazon.awscdk.services.sagemaker

Interface CfnEndpointConfig.ProductionVariantProperty

All Known Implementing Classes:

CfnEndpointConfig.ProductionVariantProperty.Jsii$Proxy

Enclosing class:

CfnEndpointConfig

public static interface CfnEndpointConfig.ProductionVariantProperty

Specifies a model that you want to host and the resources to deploy for hosting it.

If you are deploying multiple models, tell Amazon SageMaker how to distribute traffic among the models by specifying the InitialVariantWeight objects.

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.*;
 ProductionVariantProperty productionVariantProperty = ProductionVariantProperty.builder()
         .initialVariantWeight(123)
         .modelName("modelName")
         .variantName("variantName")
         // the properties below are optional
         .acceleratorType("acceleratorType")
         .containerStartupHealthCheckTimeoutInSeconds(123)
         .initialInstanceCount(123)
         .instanceType("instanceType")
         .modelDataDownloadTimeoutInSeconds(123)
         .serverlessConfig(ServerlessConfigProperty.builder()
                 .maxConcurrency(123)
                 .memorySizeInMb(123)
                 .build())
         .volumeSizeInGb(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnEndpointConfig.ProductionVariantProperty.Builder	builder()
default java.lang.String	getAcceleratorType() The size of the Elastic Inference (EI) instance to use for the production variant.
default java.lang.Number	getContainerStartupHealthCheckTimeoutInSeconds() `CfnEndpointConfig.ProductionVariantProperty.ContainerStartupHealthCheckTimeoutInSeconds`.
default java.lang.Number	getInitialInstanceCount() Number of instances to launch initially.
java.lang.Number	getInitialVariantWeight() Determines initial traffic distribution among all of the models that you specify in the endpoint configuration.
default java.lang.String	getInstanceType() The ML compute instance type.
default java.lang.Number	getModelDataDownloadTimeoutInSeconds() `CfnEndpointConfig.ProductionVariantProperty.ModelDataDownloadTimeoutInSeconds`.
java.lang.String	getModelName() The name of the model that you want to host.
default java.lang.Object	getServerlessConfig() The serverless configuration for an endpoint.
java.lang.String	getVariantName() The name of the production variant.
default java.lang.Number	getVolumeSizeInGb() `CfnEndpointConfig.ProductionVariantProperty.VolumeSizeInGB`.

Method Detail

getInitialVariantWeight

java.lang.Number getInitialVariantWeight()

Determines initial traffic distribution among all of the models that you specify in the endpoint configuration.

The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0.

getModelName

java.lang.String getModelName()

The name of the model that you want to host.

This is the name that you specified when creating the model.

getVariantName

java.lang.String getVariantName()

The name of the production variant.

getAcceleratorType

default java.lang.String getAcceleratorType()

The size of the Elastic Inference (EI) instance to use for the production variant.

EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker . For more information, see Using Elastic Inference in Amazon SageMaker .

getContainerStartupHealthCheckTimeoutInSeconds

default java.lang.Number getContainerStartupHealthCheckTimeoutInSeconds()

`CfnEndpointConfig.ProductionVariantProperty.ContainerStartupHealthCheckTimeoutInSeconds`.

getInitialInstanceCount

default java.lang.Number getInitialInstanceCount()

Number of instances to launch initially.

getInstanceType

default java.lang.String getInstanceType()

The ML compute instance type.

getModelDataDownloadTimeoutInSeconds

default java.lang.Number getModelDataDownloadTimeoutInSeconds()

`CfnEndpointConfig.ProductionVariantProperty.ModelDataDownloadTimeoutInSeconds`.

getServerlessConfig

default java.lang.Object getServerlessConfig()

The serverless configuration for an endpoint.

Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.

getVolumeSizeInGb

default java.lang.Number getVolumeSizeInGb()

`CfnEndpointConfig.ProductionVariantProperty.VolumeSizeInGB`.

builder

static CfnEndpointConfig.ProductionVariantProperty.Builder builder()

Returns:

a CfnEndpointConfig.ProductionVariantProperty.Builder of CfnEndpointConfig.ProductionVariantProperty