Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Class CfnInferenceComponentPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnInferenceComponentPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:20:04.979Z") @Stability(Stable) public class CfnInferenceComponentPropsMixin extends Mixin implements software.constructs.IMixin
Creates an inference component, which is a SageMaker AI hosting object that you can use to deploy a model to an endpoint.

In the inference component settings, you specify the model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple inference components to an endpoint, where each inference component contains one model and the resource utilization needs for that individual model. After you deploy an inference component, you can directly invoke the associated model when you use the InvokeEndpoint API action.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.sagemaker.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnInferenceComponentPropsMixin cfnInferenceComponentPropsMixin = CfnInferenceComponentPropsMixin.Builder.create(CfnInferenceComponentMixinProps.builder()
         .deploymentConfig(InferenceComponentDeploymentConfigProperty.builder()
                 .autoRollbackConfiguration(AutoRollbackConfigurationProperty.builder()
                         .alarms(List.of(AlarmProperty.builder()
                                 .alarmName("alarmName")
                                 .build()))
                         .build())
                 .rollingUpdatePolicy(InferenceComponentRollingUpdatePolicyProperty.builder()
                         .maximumBatchSize(InferenceComponentCapacitySizeProperty.builder()
                                 .type("type")
                                 .value(123)
                                 .build())
                         .maximumExecutionTimeoutInSeconds(123)
                         .rollbackMaximumBatchSize(InferenceComponentCapacitySizeProperty.builder()
                                 .type("type")
                                 .value(123)
                                 .build())
                         .waitIntervalInSeconds(123)
                         .build())
                 .build())
         .endpointArn("endpointArn")
         .endpointName("endpointName")
         .inferenceComponentName("inferenceComponentName")
         .runtimeConfig(InferenceComponentRuntimeConfigProperty.builder()
                 .copyCount(123)
                 .currentCopyCount(123)
                 .desiredCopyCount(123)
                 .build())
         .specification(InferenceComponentSpecificationProperty.builder()
                 .baseInferenceComponentName("baseInferenceComponentName")
                 .computeResourceRequirements(InferenceComponentComputeResourceRequirementsProperty.builder()
                         .maxMemoryRequiredInMb(123)
                         .minMemoryRequiredInMb(123)
                         .numberOfAcceleratorDevicesRequired(123)
                         .numberOfCpuCoresRequired(123)
                         .build())
                 .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())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .variantName("variantName")
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnInferenceComponentPropsMixin

      protected CfnInferenceComponentPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnInferenceComponentPropsMixin

      protected CfnInferenceComponentPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnInferenceComponentPropsMixin

      @Stability(Stable) public CfnInferenceComponentPropsMixin(@NotNull CfnInferenceComponentMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::SageMaker::InferenceComponent.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnInferenceComponentPropsMixin

      @Stability(Stable) public CfnInferenceComponentPropsMixin(@NotNull CfnInferenceComponentMixinProps props)
      Create a mixin to apply properties to AWS::SageMaker::InferenceComponent.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnInferenceComponentMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()