Skip to content
v2.275.0

InferenceComponentSpecificationForInstanceTypeProperty Struct ​

A specification for one instance type, for use in Specifications.

InstanceType is required here, and is not accepted on the singular Specification. BaseInferenceComponentName is not accepted here either: adapter inference components are supported only on the singular Specification.

Example ​

ts
// 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 inferenceComponentSpecificationForInstanceTypeProperty: sagemaker.CfnInferenceComponent.InferenceComponentSpecificationForInstanceTypeProperty = {
  instanceType: 'instanceType',

  // the properties below are optional
  computeResourceRequirements: {
    maxMemoryRequiredInMb: 123,
    minMemoryRequiredInMb: 123,
    numberOfAcceleratorDevicesRequired: 123,
    numberOfCpuCoresRequired: 123,
  },
  container: {
    artifactUrl: 'artifactUrl',
    containerMetricsConfig: {
      metricsEndpoints: [{
        metricsEndpointPath: 'metricsEndpointPath',

        // the properties below are optional
        metricPublishFrequencyInSeconds: 123,
      }],
    },
    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 ​

computeResourceRequirementsoptionalIResolvable | CfnInferenceComponent.InferenceComponentComputeResourceRequirementsPropertycompute_resource_requirementsoptionaltyping.Union[IResolvable, InferenceComponentComputeResourceRequirementsProperty]computeResourceRequirementsoptionalIResolvableComputeResourceRequirementsoptionalIResolvableComputeResourceRequirementsoptionalinterface{}#
Container specification for one Specifications entry.
notes

Distinct from InferenceComponentContainerSpecification: DescribeInferenceComponent returns no per-entry DeployedImage (VERIFIED in us-west-2), so DeployedImage is intentionally omitted here and this definition can never be aggregated into a plural READ response. The singular InferenceComponentContainerSpecification keeps DeployedImage - the service DOES return it there.

currentDataCacheConfigoptionalIResolvable | CfnInferenceComponent.InferenceComponentDataCacheConfigPropertycurrent_data_cache_configoptionaltyping.Union[IResolvable, InferenceComponentDataCacheConfigProperty]currentDataCacheConfigoptionalIResolvableCurrentDataCacheConfigoptionalIResolvableCurrentDataCacheConfigoptionalinterface{}#
Settings that affect how the inference component caches data.
dataCacheConfigoptionalIResolvable | CfnInferenceComponent.InferenceComponentDataCacheConfigPropertydata_cache_configoptionaltyping.Union[IResolvable, InferenceComponentDataCacheConfigProperty]dataCacheConfigoptionalIResolvableDataCacheConfigoptionalIResolvableDataCacheConfigoptionalinterface{}#
Settings that affect how the inference component caches data.
instanceTypestringinstance_typestrinstanceTypeStringInstanceTypestringInstanceType*stringrequired#
An ML compute instance type.
modelNameoptionalstringmodel_nameoptionalstrmodelNameoptionalStringModelNameoptionalstringModelNameoptional*string#
The name of the model to use with the inference component.
schedulingConfigoptionalIResolvable | CfnInferenceComponent.InferenceComponentSchedulingConfigPropertyscheduling_configoptionaltyping.Union[IResolvable, InferenceComponentSchedulingConfigProperty]schedulingConfigoptionalIResolvableSchedulingConfigoptionalIResolvableSchedulingConfigoptionalinterface{}#
The scheduling configuration that determines how inference component copies are placed across available instances.
startupParametersoptionalIResolvable | CfnInferenceComponent.InferenceComponentStartupParametersPropertystartup_parametersoptionaltyping.Union[IResolvable, InferenceComponentStartupParametersProperty]startupParametersoptionalIResolvableStartupParametersoptionalIResolvableStartupParametersoptionalinterface{}#