# CfnInferenceComponent

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.

Extends: Construct › CfnElement › CfnRefElement › CfnResource › CfnInferenceComponent
Implements: IInspectable, ITaggableV2, IEnvironmentAware, IInferenceComponentRef, IConstruct, IDependable

- CloudFormation: [`AWS::SageMaker::InferenceComponent`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-sagemaker-inferencecomponent.html)
- Source: Generated code
- Type last changed: v2.268.0 · 2 Sep 2026

## 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 cfnInferenceComponent = new sagemaker.CfnInferenceComponent(this, 'MyCfnInferenceComponent', {
  endpointName: 'endpointName',

  // the properties below are optional
  deploymentConfig: {
    autoRollbackConfiguration: {
      alarms: [{
        alarmName: 'alarmName',
      }],
    },
    rollingUpdatePolicy: {
      maximumBatchSize: {
        type: 'type',
        value: 123,
      },
      maximumExecutionTimeoutInSeconds: 123,
      rollbackMaximumBatchSize: {
        type: 'type',
        value: 123,
      },
      waitIntervalInSeconds: 123,
    },
  },
  endpointArn: 'endpointArn',
  inferenceComponentName: 'inferenceComponentName',
  runtimeConfig: {
    copyCount: 123,
    currentCopyCount: 123,
    desiredCopyCount: 123,
    placementStatus: [{
      currentCopyCount: 123,
      instanceType: 'instanceType',
    }],
  },
  specification: {
    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,
    },
  },
  specifications: [{
    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,
    },
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  variantName: 'variantName',
});
```

## Initializer

```ts
new CfnInferenceComponent(scope: Construct, id: string, props: CfnInferenceComponentProps)
```

## Construct Props

- `deploymentConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnInferenceComponent.InferenceComponentDeploymentConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnInferenceComponent.InferenceComponentDeploymentConfigProperty.html) — The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

- `endpointArn`: string — The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

- `endpointName`: string (required) — The name of the endpoint that hosts the inference component.

- `inferenceComponentName`: string — The name of the inference component.

- `runtimeConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnInferenceComponent.InferenceComponentRuntimeConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnInferenceComponent.InferenceComponentRuntimeConfigProperty.html) — The runtime config for the inference component.

- `specification`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnInferenceComponent.InferenceComponentSpecificationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnInferenceComponent.InferenceComponentSpecificationProperty.html) — The specification for the inference component, for an endpoint with a single instance type.

  Specify exactly one of Specification or Specifications. InstanceType is not accepted here; use Specifications for per instance type configuration.

- `specifications`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnInferenceComponent.InferenceComponentSpecificationForInstanceTypeProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnInferenceComponent.InferenceComponentSpecificationForInstanceTypeProperty.html)[] — A list of specification objects for the inference component, one per instance type.

  The service requires at least two entries; use the singular Specification for a single instance type.

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — An array of tags to apply to the resource.

- `variantName`: string — The name of the production variant that hosts the inference component.

## Properties

- `attrCreationTime`: string — The time when the inference component was created.

- `attrFailureReason`: string — The failure reason if the inference component is in a failed state.

- `attrInferenceComponentArn`: string — The Amazon Resource Name (ARN) of the inference component.

- `attrInferenceComponentStatus`: string — The status of the inference component.

- `attrLastModifiedTime`: string — The time when the inference component was last updated.

- `attrRuntimeConfigCurrentCopyCount`: number — The number of runtime copies of the model container that are currently deployed.

- `attrRuntimeConfigDesiredCopyCount`: number — The number of runtime copies of the model container that you requested to deploy with the inference component.

- `attrRuntimeConfigPlacementStatus`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — The placement status of the inference component across instance types.

- `attrSpecificationContainerDeployedImage`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html)

- `attrSpecificationCurrentDataCacheConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Settings that affect how the inference component caches data.

- `cdkTagManager`: [TagManager](/cdk/api/v2/docs/aws-cdk-lib.TagManager.html) — Tag Manager which manages the tags for this resource.

- `CFN_RESOURCE_TYPE_NAME`: string (static) — The CloudFormation resource type name for this resource class.

- `cfnOptions`: [ICfnResourceOptions](/cdk/api/v2/docs/aws-cdk-lib.ICfnResourceOptions.html) — Options for this resource, such as condition, update policy etc.

- `cfnResourceType`: string — AWS resource type.

- `creationStack`: string[]

- `deploymentConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnInferenceComponent.InferenceComponentDeploymentConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnInferenceComponent.InferenceComponentDeploymentConfigProperty.html) — The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

- `endpointArn`: string — The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

- `endpointName`: string — The name of the endpoint that hosts the inference component.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html)

- `inferenceComponentName`: string — The name of the inference component.

- `inferenceComponentRef`: [InferenceComponentReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_sagemaker.InferenceComponentReference.html) — A reference to a InferenceComponent resource.

- `logicalId`: string — The logical ID for this CloudFormation stack element.

  The logical ID of the element
  is calculated from the path of the resource node in the construct tree.

  To override this value, use `overrideLogicalId(newLogicalId)`.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `ref`: string — Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

  If, by any chance, the intrinsic reference of a resource is not a string, you could
  coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.

- `runtimeConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnInferenceComponent.InferenceComponentRuntimeConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnInferenceComponent.InferenceComponentRuntimeConfigProperty.html) — The runtime config for the inference component.

- `specification`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnInferenceComponent.InferenceComponentSpecificationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnInferenceComponent.InferenceComponentSpecificationProperty.html) — The specification for the inference component, for an endpoint with a single instance type.

- `specifications`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnInferenceComponent.InferenceComponentSpecificationForInstanceTypeProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnInferenceComponent.InferenceComponentSpecificationForInstanceTypeProperty.html)[] — A list of specification objects for the inference component, one per instance type.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this element is defined.

  CfnElements must be defined within a stack scope (directly or indirectly).

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — An array of tags to apply to the resource.

- `variantName`: string — The name of the production variant that hosts the inference component.

## Methods

- `addDeletionOverride(path: string): void` — Syntactic sugar for `addOverride(path, undefined)`.

  **Parameters**

  - `path` — The path of the value to delete.

- `addDependency(target: CfnResource): void` — Use `addResourceDependency` instead.

  This method has been renamed to `addResourceDependency` to more clearly
  set it apart from `construct.node.addDependency`. See the documentation
  of that function for more details.

- `addDependsOn(target: CfnResource): void` — Use `addResourceDependency` instead.

  This can be used for resources across stacks (or nested stack) boundaries
  and the dependency will automatically be transferred to the relevant scope.

  This method has been renamed to `addResourceDependency`, which makes it
  more clear that this method operates at a different level from the
  construct-level `construct.node.addDependency()` mechanism.

- `addMetadata(key: string, value: any): void` — Add a value to the CloudFormation Resource Metadata.

- `addOverride(path: string, value: any): void` — Adds an override to the synthesized CloudFormation resource.

  To add a
  property override, either use `addPropertyOverride` or prefix `path` with
  "Properties." (i.e. `Properties.TopicName`).

  If the override is nested, separate each nested level using a dot (.) in the path parameter.
  If there is an array as part of the nesting, specify the index in the path.

  To include a literal `.` in the property name, prefix with a `\`. In most
  programming languages you will need to write this as `"\\."` because the
  `\` itself will need to be escaped.

  For example,
  ```typescript
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
  ```
  would add the overrides
  ```json
  "Properties": {
    "GlobalSecondaryIndexes": [
      {
        "Projection": {
          "NonKeyAttributes": [ "myattribute" ]
          ...
        }
        ...
      },
      {
        "ProjectionType": "INCLUDE"
        ...
      },
    ]
    ...
  }
  ```

  The `value` argument to `addOverride` will not be processed or translated
  in any way. Pass raw JSON values in here with the correct capitalization
  for CloudFormation. If you pass CDK classes or structs, they will be
  rendered with lowercased key names, and CloudFormation will reject the
  template.

  **Parameters**

  - `path` — - The path of the property, you can use dot notation to override values in complex types.
  - `value` — - The value.

- `addPropertyDeletionOverride(propertyPath: string): void` — Adds an override that deletes the value of a property from the resource definition.

  **Parameters**

  - `propertyPath` — The path to the property.

- `addPropertyOverride(propertyPath: string, value: any): void` — Adds an override to a resource property.

  Syntactic sugar for `addOverride("Properties.<...>", value)`.

  **Parameters**

  - `propertyPath` — The path of the property.
  - `value` — The value.

- `addResourceDependency(target: CfnResource, reason?: string): void` — Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

  This can be used for resources across stacks (or nested stack) boundaries
  and the dependency will automatically be transferred to the relevant scope.

  This method only adds dependencies between L1 resources. If you are
  looking for a generic construct-to-construct dependency mechanism that works
  for all constructs including L2s, use `construct.node.addDependency` instead.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Sets the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  strength instead of the global default from the consuming stack's context.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void` — Sets the deletion policy of the resource based on the removal policy specified.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
  cases, a snapshot can be taken of the resource prior to deletion
  (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
  can be found in the following link:

- `arnForInferenceComponent(resource: IInferenceComponentRef): string` (static)

- `cfnPropertyName(cdkPropertyName: string): string`

- `getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference` — Returns a token for an runtime attribute of this resource.

  Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
  in case there is no generated attribute.

  **Parameters**

  - `attributeName` — The name of the attribute.

- `getMetadata(key: string): any` — Retrieve a value value from the CloudFormation Resource Metadata.

- `inspect(inspector: TreeInspector): void` — Examines the CloudFormation resource and discloses attributes.

  **Parameters**

  - `inspector` — tree inspector to collect and process attributes.

- `isCfnElement(x: any): boolean` (static) — Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

  Uses duck-typing instead of `instanceof` to allow stack elements from different
  versions of this library to be included in the same stack.

  **Returns:** The construct as a stack element or undefined if it is not a stack element.

- `isCfnInferenceComponent(x: any): boolean` (static) — Checks whether the given object is a CfnInferenceComponent.

- `isCfnResource(x: any): boolean` (static) — Check whether the given object is a CfnResource.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `obtainDependencies(): Stack | CfnResource[]` — Retrieves an array of resources and stacks this resource depends on.

  For resources depended on directly, returns the `CfnResource` object. For
  dependencies on other stacks, returns the `Stack` object. The order of the
  array is not guaranteed.

- `overrideLogicalId(newLogicalId: string): void` — Overrides the auto-generated logical ID with a specific ID.

  **Parameters**

  - `newLogicalId` — The new logical ID to use for this stack element.

- `removeDependency(target: CfnResource): void` — Use `removeResourceDependency` instead

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `removeResourceDependency(target: CfnResource): void` — Indicates that this resource no longer depends on another resource.

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `replaceDependency(target: CfnResource, newTarget: CfnResource): void` — Replaces one dependency with another.

  **Parameters**

  - `target` — The dependency to replace.
  - `newTarget` — The new dependency to add.

- `toString(): string` — Returns a string representation of this construct.

  **Returns:** a string representation of this resource

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.