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

  • Method Details

    • getInitialVariantWeight

      @Stability(Stable) @NotNull 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

      @Stability(Stable) @NotNull String getModelName()
      The name of the model that you want to host.

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

    • getVariantName

      @Stability(Stable) @NotNull String getVariantName()
      The name of the production variant.

    • 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 .

    • getContainerStartupHealthCheckTimeoutInSeconds

      @Stability(Stable) @Nullable default Number getContainerStartupHealthCheckTimeoutInSeconds()
      CfnEndpointConfig.ProductionVariantProperty.ContainerStartupHealthCheckTimeoutInSeconds.

    • getEnableSsmAccess

      @Stability(Stable) @Nullable default Object getEnableSsmAccess()
      CfnEndpointConfig.ProductionVariantProperty.EnableSSMAccess.

    • getInitialInstanceCount

      @Stability(Stable) @Nullable default Number getInitialInstanceCount()
      Number of instances to launch initially.

    • getInstanceType

      @Stability(Stable) @Nullable default String getInstanceType()
      The ML compute instance type.

    • getModelDataDownloadTimeoutInSeconds

      @Stability(Stable) @Nullable default Number getModelDataDownloadTimeoutInSeconds()
      CfnEndpointConfig.ProductionVariantProperty.ModelDataDownloadTimeoutInSeconds.

    • 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.

    • getVolumeSizeInGb

      @Stability(Stable) @Nullable default Number getVolumeSizeInGb()
      CfnEndpointConfig.ProductionVariantProperty.VolumeSizeInGB.

    • builder

      @Stability(Stable) static CfnEndpointConfig.ProductionVariantProperty.Builder builder()
      Returns:
      a CfnEndpointConfig.ProductionVariantProperty.Builder of CfnEndpointConfig.ProductionVariantProperty