Package software.amazon.awscdk.services.sagemaker

Class CfnInferenceComponent

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.sagemaker.CfnInferenceComponent
All Implemented Interfaces:
IInspectable, ITaggableV2, IInferenceComponentRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:48.040Z") @Stability(Stable) public class CfnInferenceComponent extends CfnResource implements IInspectable, IInferenceComponentRef, ITaggableV2
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.services.sagemaker.*;
 CfnInferenceComponent cfnInferenceComponent = CfnInferenceComponent.Builder.create(this, "MyCfnInferenceComponent")
         .endpointName("endpointName")
         .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())
         // the properties below are optional
         .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")
         .inferenceComponentName("inferenceComponentName")
         .runtimeConfig(InferenceComponentRuntimeConfigProperty.builder()
                 .copyCount(123)
                 .currentCopyCount(123)
                 .desiredCopyCount(123)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .variantName("variantName")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnInferenceComponent

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

    • CfnInferenceComponent

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

    • CfnInferenceComponent

      @Stability(Stable) public CfnInferenceComponent(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnInferenceComponentProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      The time when the inference component was created.

    • getAttrFailureReason

      @Stability(Stable) @NotNull public String getAttrFailureReason()
      The failure reason if the inference component is in a failed state.

    • getAttrInferenceComponentArn

      @Stability(Stable) @NotNull public String getAttrInferenceComponentArn()
      The Amazon Resource Name (ARN) of the inference component.

    • getAttrInferenceComponentStatus

      @Stability(Stable) @NotNull public String getAttrInferenceComponentStatus()
      The status of the inference component.

    • getAttrLastModifiedTime

      @Stability(Stable) @NotNull public String getAttrLastModifiedTime()
      The time when the inference component was last updated.

    • getAttrRuntimeConfigCurrentCopyCount

      @Stability(Stable) @NotNull public Number getAttrRuntimeConfigCurrentCopyCount()
      The number of runtime copies of the model container that are currently deployed.

    • getAttrRuntimeConfigDesiredCopyCount

      @Stability(Stable) @NotNull public Number getAttrRuntimeConfigDesiredCopyCount()
      The number of runtime copies of the model container that you requested to deploy with the inference component.

    • getAttrSpecificationContainerDeployedImage

      @Stability(Stable) @NotNull public IResolvable getAttrSpecificationContainerDeployedImage()

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getInferenceComponentRef

      @Stability(Stable) @NotNull public InferenceComponentReference getInferenceComponentRef()
      A reference to a InferenceComponent resource.
      Specified by:
      getInferenceComponentRef in interface IInferenceComponentRef

    • getEndpointName

      @Stability(Stable) @NotNull public String getEndpointName()
      The name of the endpoint that hosts the inference component.

    • setEndpointName

      @Stability(Stable) public void setEndpointName(@NotNull String value)
      The name of the endpoint that hosts the inference component.

    • getSpecification

      @Stability(Stable) @NotNull public Object getSpecification()
      The specification for the inference component.

      Returns union: either IResolvable or CfnInferenceComponent.InferenceComponentSpecificationProperty

    • setSpecification

      @Stability(Stable) public void setSpecification(@NotNull IResolvable value)
      The specification for the inference component.

    • setSpecification

      @Stability(Stable) public void setSpecification(@NotNull CfnInferenceComponent.InferenceComponentSpecificationProperty value)
      The specification for the inference component.

    • getDeploymentConfig

      @Stability(Stable) @Nullable public Object getDeploymentConfig()
      The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

      Returns union: either IResolvable or CfnInferenceComponent.InferenceComponentDeploymentConfigProperty

    • setDeploymentConfig

      @Stability(Stable) public void setDeploymentConfig(@Nullable IResolvable value)
      The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

    • setDeploymentConfig

      @Stability(Stable) public void setDeploymentConfig(@Nullable CfnInferenceComponent.InferenceComponentDeploymentConfigProperty value)
      The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

    • getEndpointArn

      @Stability(Stable) @Nullable public String getEndpointArn()
      The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

    • setEndpointArn

      @Stability(Stable) public void setEndpointArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

    • getInferenceComponentName

      @Stability(Stable) @Nullable public String getInferenceComponentName()
      The name of the inference component.

    • setInferenceComponentName

      @Stability(Stable) public void setInferenceComponentName(@Nullable String value)
      The name of the inference component.

    • getRuntimeConfig

      @Stability(Stable) @Nullable public Object getRuntimeConfig()
      The runtime config for the inference component.

      Returns union: either IResolvable or CfnInferenceComponent.InferenceComponentRuntimeConfigProperty

    • setRuntimeConfig

      @Stability(Stable) public void setRuntimeConfig(@Nullable IResolvable value)
      The runtime config for the inference component.

    • setRuntimeConfig

      @Stability(Stable) public void setRuntimeConfig(@Nullable CfnInferenceComponent.InferenceComponentRuntimeConfigProperty value)
      The runtime config for the inference component.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of tags to apply to the resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of tags to apply to the resource.

    • getVariantName

      @Stability(Stable) @Nullable public String getVariantName()
      The name of the production variant that hosts the inference component.

    • setVariantName

      @Stability(Stable) public void setVariantName(@Nullable String value)
      The name of the production variant that hosts the inference component.