Package software.amazon.awscdk.services.sagemaker

Interface CfnEndpointConfig.ProductionVariantProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpointConfig.ProductionVariantProperty.Jsii$Proxy

Enclosing class:

CfnEndpointConfig

@Stability(Stable)
public static interface CfnEndpointConfig.ProductionVariantProperty
extends software.amazon.jsii.JsiiSerializable

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()
         .variantName("variantName")
         // the properties below are optional
         .acceleratorType("acceleratorType")
         .capacityReservationConfig(CapacityReservationConfigProperty.builder()
                 .capacityReservationPreference("capacityReservationPreference")
                 .mlReservationArn("mlReservationArn")
                 .build())
         .containerStartupHealthCheckTimeoutInSeconds(123)
         .coreDumpConfig(CoreDumpConfigProperty.builder()
                 .destinationS3Uri("destinationS3Uri")
                 // the properties below are optional
                 .kmsKeyId("kmsKeyId")
                 .build())
         .enableSsmAccess(false)
         .inferenceAmiVersion("inferenceAmiVersion")
         .initialInstanceCount(123)
         .initialVariantWeight(123)
         .instancePools(List.of(InstancePoolProperty.builder()
                 .instanceType("instanceType")
                 .priority(123)
                 // the properties below are optional
                 .modelNameOverride("modelNameOverride")
                 .build()))
         .instanceType("instanceType")
         .managedInstanceScaling(ManagedInstanceScalingProperty.builder()
                 .maxInstanceCount(123)
                 .minInstanceCount(123)
                 .scaleInPolicy(ScaleInPolicyProperty.builder()
                         .strategy("strategy")
                         // the properties below are optional
                         .cooldownInMinutes(123)
                         .maximumStepSize(123)
                         .build())
                 .status("status")
                 .build())
         .modelDataDownloadTimeoutInSeconds(123)
         .modelName("modelName")
         .routingConfig(RoutingConfigProperty.builder()
                 .prefixAwareRoutingConfig(PrefixAwareRoutingConfigProperty.builder()
                         .concurrencyThreshold(123)
                         .prefixLength(123)
                         .build())
                 .routingStrategy("routingStrategy")
                 .build())
         .serverlessConfig(ServerlessConfigProperty.builder()
                 .maxConcurrency(123)
                 .memorySizeInMb(123)
                 // the properties below are optional
                 .provisionedConcurrency(123)
                 .build())
         .variantInstanceProvisionTimeoutInSeconds(123)
         .volumeSizeInGb(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnEndpointConfig.ProductionVariantProperty.Builder	builder()
default String	getAcceleratorType()	The size of the Elastic Inference (EI) instance to use for the production variant.
default Object	getCapacityReservationConfig()	Settings for the capacity reservation for the compute instances that SageMaker AI reserves for an endpoint.
default Number	getContainerStartupHealthCheckTimeoutInSeconds()	The timeout value, in seconds, for your inference container to pass health check by SageMaker Hosting.
default Object	getCoreDumpConfig()	Specifies where SageMaker writes core dumps from the model container when the process crashes, and how it encrypts them.
default Object	getEnableSsmAccess()	You can use this parameter to turn on native AWS Systems Manager (SSM) access for a production variant behind an endpoint.
default String	getInferenceAmiVersion()	Specifies an option from a collection of preconfigured Amazon Machine Image (AMI) images.
default Number	getInitialInstanceCount()	Number of instances to launch initially.
default Number	getInitialVariantWeight()	Determines initial traffic distribution among all of the models that you specify in the endpoint configuration.
default Object	getInstancePools()	A list of instance pools for the production variant.
default String	getInstanceType()	The ML compute instance type.
default Object	getManagedInstanceScaling()	Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.
default Number	getModelDataDownloadTimeoutInSeconds()	The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this production variant.
default String	getModelName()	The name of the model that you want to host.
default Object	getRoutingConfig()	Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.
default Object	getServerlessConfig()	The serverless configuration for an endpoint.
default Number	getVariantInstanceProvisionTimeoutInSeconds()	The timeout value, in seconds, for provisioning instances for the production variant.
String	getVariantName()	The name of the production variant.
default Number	getVolumeSizeInGb()	The size, in GB, of the ML storage volume attached to individual inference instance associated with the production variant.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getVariantName

@Stability(Stable)
@NotNull
String getVariantName()

The name of the production variant.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-variantname

getAcceleratorType

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-acceleratortype

getCapacityReservationConfig

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

Settings for the capacity reservation for the compute instances that SageMaker AI reserves for an endpoint.

Returns union: either IResolvable or CfnEndpointConfig.CapacityReservationConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-capacityreservationconfig

getContainerStartupHealthCheckTimeoutInSeconds

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

The timeout value, in seconds, for your inference container to pass health check by SageMaker Hosting.

For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-containerstartuphealthchecktimeoutinseconds

getCoreDumpConfig

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

Specifies where SageMaker writes core dumps from the model container when the process crashes, and how it encrypts them.

Returns union: either IResolvable or CfnEndpointConfig.CoreDumpConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-coredumpconfig

getEnableSsmAccess

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

You can use this parameter to turn on native AWS Systems Manager (SSM) access for a production variant behind an endpoint.

By default, SSM access is disabled for all production variants behind an endpoint. You can turn on or turn off SSM access for a production variant behind an existing endpoint by creating a new endpoint configuration and calling UpdateEndpoint .

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-enablessmaccess

getInferenceAmiVersion

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

Specifies an option from a collection of preconfigured Amazon Machine Image (AMI) images.

Each image is configured by AWS with a set of software and driver versions. AWS optimizes these configurations for different machine learning workloads. By selecting an AMI version, you can ensure that your inference environment is compatible with specific software requirements, such as CUDA driver versions, Linux kernel versions, or AWS Neuron driver versions

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-inferenceamiversion

getInitialInstanceCount

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

Number of instances to launch initially.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-initialinstancecount

getInitialVariantWeight

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-initialvariantweight

getInstancePools

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

A list of instance pools for the production variant.

Each instance pool specifies an instance type and its priority for provisioning. Use instance pools to configure heterogeneous endpoints that deploy models across multiple instance types.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnEndpointConfig.InstancePoolProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-instancepools

getInstanceType

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

The ML compute instance type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-instancetype

getManagedInstanceScaling

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

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

Returns union: either IResolvable or CfnEndpointConfig.ManagedInstanceScalingProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-managedinstancescaling

getModelDataDownloadTimeoutInSeconds

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

The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this production variant.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-modeldatadownloadtimeoutinseconds

getModelName

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

The name of the model that you want to host.

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

See Also:

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

getRoutingConfig

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

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

Returns union: either IResolvable or CfnEndpointConfig.RoutingConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-routingconfig

getServerlessConfig

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

The serverless configuration for an endpoint.

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

Returns union: either IResolvable or CfnEndpointConfig.ServerlessConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-serverlessconfig

getVariantInstanceProvisionTimeoutInSeconds

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

The timeout value, in seconds, for provisioning instances for the production variant.

When SageMaker encounters an insufficient capacity error while provisioning instances, it retries with the next instance pool (if configured) or waits until the timeout expires. This timeout applies only to capacity provisioning and does not include the time for model download or container startup.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-variantinstanceprovisiontimeoutinseconds

getVolumeSizeInGb

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

The size, in GB, of the ML storage volume attached to individual inference instance associated with the production variant.

Currently only Amazon EBS gp2 storage volumes are supported.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html#cfn-sagemaker-endpointconfig-productionvariant-volumesizeingb

builder

@Stability(Stable)
static CfnEndpointConfig.ProductionVariantProperty.Builder builder()

Returns:

a CfnEndpointConfig.ProductionVariantProperty.Builder of CfnEndpointConfig.ProductionVariantProperty