Package software.amazon.awscdk.services.sagemaker

Class CfnEndpointConfig.ProductionVariantProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.sagemaker.CfnEndpointConfig.ProductionVariantProperty.Jsii$Proxy

All Implemented Interfaces:

CfnEndpointConfig.ProductionVariantProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnEndpointConfig.ProductionVariantProperty

@Stability(Stable)
@Internal
public static final class CfnEndpointConfig.ProductionVariantProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnEndpointConfig.ProductionVariantProperty

An implementation for CfnEndpointConfig.ProductionVariantProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.sagemaker.CfnEndpointConfig.ProductionVariantProperty

CfnEndpointConfig.ProductionVariantProperty.Builder, CfnEndpointConfig.ProductionVariantProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnEndpointConfig.ProductionVariantProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnEndpointConfig.ProductionVariantProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getAcceleratorType()	The size of the Elastic Inference (EI) instance to use for the production variant.
final Object	getCapacityReservationConfig()	Settings for the capacity reservation for the compute instances that SageMaker AI reserves for an endpoint.
final Number	getContainerStartupHealthCheckTimeoutInSeconds()	The timeout value, in seconds, for your inference container to pass health check by SageMaker Hosting.
final Object	getCoreDumpConfig()	Specifies where SageMaker writes core dumps from the model container when the process crashes, and how it encrypts them.
final Object	getEnableSsmAccess()	You can use this parameter to turn on native AWS Systems Manager (SSM) access for a production variant behind an endpoint.
final String	getInferenceAmiVersion()	Specifies an option from a collection of preconfigured Amazon Machine Image (AMI) images.
final Number	getInitialInstanceCount()	Number of instances to launch initially.
final Number	getInitialVariantWeight()	Determines initial traffic distribution among all of the models that you specify in the endpoint configuration.
final Object	getInstancePools()	A list of instance pools for the production variant.
final String	getInstanceType()	The ML compute instance type.
final 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.
final 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.
final String	getModelName()	The name of the model that you want to host.
final Object	getRoutingConfig()	Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.
final Object	getServerlessConfig()	The serverless configuration for an endpoint.
final Number	getVariantInstanceProvisionTimeoutInSeconds()	The timeout value, in seconds, for provisioning instances for the production variant.
final String	getVariantName()	The name of the production variant.
final Number	getVolumeSizeInGb()	The size, in GB, of the ML storage volume attached to individual inference instance associated with the production variant.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnEndpointConfig.ProductionVariantProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnEndpointConfig.ProductionVariantProperty.Builder.

Method Details

getVariantName

public final String getVariantName()

Description copied from interface: CfnEndpointConfig.ProductionVariantProperty

The name of the production variant.

Specified by:

getVariantName in interface CfnEndpointConfig.ProductionVariantProperty

See Also:

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

getAcceleratorType

public final String getAcceleratorType()

Description copied from interface: CfnEndpointConfig.ProductionVariantProperty

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 .

Specified by:

getAcceleratorType in interface CfnEndpointConfig.ProductionVariantProperty

See Also:

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

getCapacityReservationConfig

public final Object getCapacityReservationConfig()

Description copied from interface: CfnEndpointConfig.ProductionVariantProperty

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

Returns union: either IResolvable or CfnEndpointConfig.CapacityReservationConfigProperty

Specified by:

getCapacityReservationConfig in interface CfnEndpointConfig.ProductionVariantProperty

See Also:

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

getContainerStartupHealthCheckTimeoutInSeconds

public final Number getContainerStartupHealthCheckTimeoutInSeconds()

Description copied from interface: CfnEndpointConfig.ProductionVariantProperty

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 .

Specified by:

getContainerStartupHealthCheckTimeoutInSeconds in interface CfnEndpointConfig.ProductionVariantProperty

See Also:

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

getCoreDumpConfig

public final Object getCoreDumpConfig()

Description copied from interface: CfnEndpointConfig.ProductionVariantProperty

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

Specified by:

getCoreDumpConfig in interface CfnEndpointConfig.ProductionVariantProperty

See Also:

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

getEnableSsmAccess

public final Object getEnableSsmAccess()

Description copied from interface: CfnEndpointConfig.ProductionVariantProperty

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

Specified by:

getEnableSsmAccess in interface CfnEndpointConfig.ProductionVariantProperty

See Also:

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

getInferenceAmiVersion

public final String getInferenceAmiVersion()

Description copied from interface: CfnEndpointConfig.ProductionVariantProperty

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

Specified by:

getInferenceAmiVersion in interface CfnEndpointConfig.ProductionVariantProperty

See Also:

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

getInitialInstanceCount

public final Number getInitialInstanceCount()

Description copied from interface: CfnEndpointConfig.ProductionVariantProperty

Number of instances to launch initially.

Specified by:

getInitialInstanceCount in interface CfnEndpointConfig.ProductionVariantProperty

See Also:

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

getInitialVariantWeight

public final Number getInitialVariantWeight()

Description copied from interface: CfnEndpointConfig.ProductionVariantProperty

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.

Specified by:

getInitialVariantWeight in interface CfnEndpointConfig.ProductionVariantProperty

See Also:

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

getInstancePools

public final Object getInstancePools()

Description copied from interface: CfnEndpointConfig.ProductionVariantProperty

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>

Specified by:

getInstancePools in interface CfnEndpointConfig.ProductionVariantProperty

See Also:

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

getInstanceType

public final String getInstanceType()

Description copied from interface: CfnEndpointConfig.ProductionVariantProperty

The ML compute instance type.

Specified by:

getInstanceType in interface CfnEndpointConfig.ProductionVariantProperty

See Also:

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

getManagedInstanceScaling

public final Object getManagedInstanceScaling()

Description copied from interface: CfnEndpointConfig.ProductionVariantProperty

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

Specified by:

getManagedInstanceScaling in interface CfnEndpointConfig.ProductionVariantProperty

See Also:

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

getModelDataDownloadTimeoutInSeconds

public final Number getModelDataDownloadTimeoutInSeconds()

Description copied from interface: CfnEndpointConfig.ProductionVariantProperty

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.

Specified by:

getModelDataDownloadTimeoutInSeconds in interface CfnEndpointConfig.ProductionVariantProperty

See Also:

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

getModelName

public final String getModelName()

Description copied from interface: CfnEndpointConfig.ProductionVariantProperty

The name of the model that you want to host.

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

Specified by:

getModelName in interface CfnEndpointConfig.ProductionVariantProperty

See Also:

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

getRoutingConfig

public final Object getRoutingConfig()

Description copied from interface: CfnEndpointConfig.ProductionVariantProperty

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

Returns union: either IResolvable or CfnEndpointConfig.RoutingConfigProperty

Specified by:

getRoutingConfig in interface CfnEndpointConfig.ProductionVariantProperty

See Also:

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

getServerlessConfig

public final Object getServerlessConfig()

Description copied from interface: CfnEndpointConfig.ProductionVariantProperty

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

Specified by:

getServerlessConfig in interface CfnEndpointConfig.ProductionVariantProperty

See Also:

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

getVariantInstanceProvisionTimeoutInSeconds

public final Number getVariantInstanceProvisionTimeoutInSeconds()

Description copied from interface: CfnEndpointConfig.ProductionVariantProperty

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.

Specified by:

getVariantInstanceProvisionTimeoutInSeconds in interface CfnEndpointConfig.ProductionVariantProperty

See Also:

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

getVolumeSizeInGb

public final Number getVolumeSizeInGb()

Description copied from interface: CfnEndpointConfig.ProductionVariantProperty

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.

Specified by:

getVolumeSizeInGb in interface CfnEndpointConfig.ProductionVariantProperty

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object