aws-cdk-lib.aws_sagemaker.CfnInferenceComponent.InferenceComponentSpecificationProperty

InferenceComponentSpecificationProperty Struct

Details about the resources to deploy with this inference component, including the model, container, and compute resources.

Source

Generated code

Type last changed

v2.268.0 · 2 Sep 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const inferenceComponentSpecificationProperty: sagemaker.CfnInferenceComponent.InferenceComponentSpecificationProperty = {
  baseInferenceComponentName: 'baseInferenceComponentName',
  computeResourceRequirements: {
    maxMemoryRequiredInMb: 123,
    minMemoryRequiredInMb: 123,
    numberOfAcceleratorDevicesRequired: 123,
    numberOfCpuCoresRequired: 123,
  },
  container: {
    artifactUrl: 'artifactUrl',
    containerMetricsConfig: {
      metricsEndpoints: [{
        metricsEndpointPath: 'metricsEndpointPath',

        // the properties below are optional
        metricPublishFrequencyInSeconds: 123,
      }],
    },
    deployedImage: {
      resolutionTime: 'resolutionTime',
      resolvedImage: 'resolvedImage',
      specifiedImage: 'specifiedImage',
    },
    environment: {
      environmentKey: 'environment',
    },
    image: 'image',
  },
  currentDataCacheConfig: {
    enableCaching: false,
  },
  dataCacheConfig: {
    enableCaching: false,
  },
  modelName: 'modelName',
  schedulingConfig: {
    availabilityZoneBalance: {
      enforcementMode: 'enforcementMode',

      // the properties below are optional
      maxImbalance: 123,
    },
    placementStrategy: 'placementStrategy',
  },
  startupParameters: {
    containerStartupHealthCheckTimeoutInSeconds: 123,
    modelDataDownloadTimeoutInSeconds: 123,
  },
};

Properties

baseInferenceComponentName?optionalstringbase_inference_component_name?optionalstrbaseInferenceComponentName?optionalStringBaseInferenceComponentName?optionalstringBaseInferenceComponentName?optional*string#

The name of an existing inference component that is to contain the inference component that you're creating with your request.

notes

Specify this parameter only if your request is meant to create an adapter inference component. An adapter inference component contains the path to an adapter model. The purpose of the adapter model is to tailor the inference output of a base foundation model, which is hosted by the base inference component. The adapter inference component uses the compute resources that you assigned to the base inference component.

When you create an adapter inference component, use the Container parameter to specify the location of the adapter artifacts. In the parameter value, use the ArtifactUrl parameter of the InferenceComponentContainerSpecification data type.

Before you can create an adapter inference component, you must have an existing inference component that contains the foundation model that you want to adapt.

computeResourceRequirements?optionalIResolvable | CfnInferenceComponent.InferenceComponentComputeResourceRequirementsPropertycompute_resource_requirements?optionaltyping.Union[IResolvable, InferenceComponentComputeResourceRequirementsProperty]computeResourceRequirements?optionalIResolvableComputeResourceRequirements?optionalIResolvableComputeResourceRequirements?optionalinterface{}#

The compute resources allocated to run the model, plus any adapter models, that you assign to the inference component.

Omit this parameter if your request is meant to create an adapter inference component. An adapter inference component is loaded by a base inference component, and it uses the compute resources of the base inference component.

container?optionalIResolvable | CfnInferenceComponent.InferenceComponentContainerSpecificationPropertycontainer?optionaltyping.Union[IResolvable, InferenceComponentContainerSpecificationProperty]container?optionalIResolvableContainer?optionalIResolvableContainer?optionalinterface{}#

Defines a container that provides the runtime environment for a model that you deploy with an inference component.

currentDataCacheConfig?optionalIResolvable | CfnInferenceComponent.InferenceComponentDataCacheConfigPropertycurrent_data_cache_config?optionaltyping.Union[IResolvable, InferenceComponentDataCacheConfigProperty]currentDataCacheConfig?optionalIResolvableCurrentDataCacheConfig?optionalIResolvableCurrentDataCacheConfig?optionalinterface{}#

Settings that affect how the inference component caches data.

dataCacheConfig?optionalIResolvable | CfnInferenceComponent.InferenceComponentDataCacheConfigPropertydata_cache_config?optionaltyping.Union[IResolvable, InferenceComponentDataCacheConfigProperty]dataCacheConfig?optionalIResolvableDataCacheConfig?optionalIResolvableDataCacheConfig?optionalinterface{}#

Settings that affect how the inference component caches data.

modelName?optionalstringmodel_name?optionalstrmodelName?optionalStringModelName?optionalstringModelName?optional*string#

The name of an existing SageMaker AI model object in your account that you want to deploy with the inference component.

schedulingConfig?optionalIResolvable | CfnInferenceComponent.InferenceComponentSchedulingConfigPropertyscheduling_config?optionaltyping.Union[IResolvable, InferenceComponentSchedulingConfigProperty]schedulingConfig?optionalIResolvableSchedulingConfig?optionalIResolvableSchedulingConfig?optionalinterface{}#

The scheduling configuration that determines how inference component copies are placed across available instances.

startupParameters?optionalIResolvable | CfnInferenceComponent.InferenceComponentStartupParametersPropertystartup_parameters?optionaltyping.Union[IResolvable, InferenceComponentStartupParametersProperty]startupParameters?optionalIResolvableStartupParameters?optionalIResolvableStartupParameters?optionalinterface{}#

Settings that take effect while the model container starts up.