Package software.amazon.awscdk.services.sagemaker

Interface CfnInferenceComponentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnInferenceComponentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:18.564Z")
@Stability(Stable)
public interface CfnInferenceComponentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnInferenceComponent.

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.*;
 CfnInferenceComponentProps cfnInferenceComponentProps = CfnInferenceComponentProps.builder()
         .endpointName("endpointName")
         // 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)
                 .placementStatus(List.of(InferenceComponentPlacementStatusProperty.builder()
                         .currentCopyCount(123)
                         .instanceType("instanceType")
                         .build()))
                 .build())
         .specification(InferenceComponentSpecificationProperty.builder()
                 .baseInferenceComponentName("baseInferenceComponentName")
                 .computeResourceRequirements(InferenceComponentComputeResourceRequirementsProperty.builder()
                         .maxMemoryRequiredInMb(123)
                         .minMemoryRequiredInMb(123)
                         .numberOfAcceleratorDevicesRequired(123)
                         .numberOfCpuCoresRequired(123)
                         .build())
                 .container(InferenceComponentContainerSpecificationProperty.builder()
                         .artifactUrl("artifactUrl")
                         .containerMetricsConfig(ContainerMetricsConfigProperty.builder()
                                 .metricsEndpoints(List.of(MetricsEndpointProperty.builder()
                                         .metricsEndpointPath("metricsEndpointPath")
                                         // the properties below are optional
                                         .metricPublishFrequencyInSeconds(123)
                                         .build()))
                                 .build())
                         .deployedImage(DeployedImageProperty.builder()
                                 .resolutionTime("resolutionTime")
                                 .resolvedImage("resolvedImage")
                                 .specifiedImage("specifiedImage")
                                 .build())
                         .environment(Map.of(
                                 "environmentKey", "environment"))
                         .image("image")
                         .build())
                 .currentDataCacheConfig(InferenceComponentDataCacheConfigProperty.builder()
                         .enableCaching(false)
                         .build())
                 .dataCacheConfig(InferenceComponentDataCacheConfigProperty.builder()
                         .enableCaching(false)
                         .build())
                 .modelName("modelName")
                 .schedulingConfig(InferenceComponentSchedulingConfigProperty.builder()
                         .availabilityZoneBalance(InferenceComponentAvailabilityZoneBalanceProperty.builder()
                                 .enforcementMode("enforcementMode")
                                 // the properties below are optional
                                 .maxImbalance(123)
                                 .build())
                         .placementStrategy("placementStrategy")
                         .build())
                 .startupParameters(InferenceComponentStartupParametersProperty.builder()
                         .containerStartupHealthCheckTimeoutInSeconds(123)
                         .modelDataDownloadTimeoutInSeconds(123)
                         .build())
                 .build())
         .specifications(List.of(InferenceComponentSpecificationForInstanceTypeProperty.builder()
                 .instanceType("instanceType")
                 // the properties below are optional
                 .computeResourceRequirements(InferenceComponentComputeResourceRequirementsProperty.builder()
                         .maxMemoryRequiredInMb(123)
                         .minMemoryRequiredInMb(123)
                         .numberOfAcceleratorDevicesRequired(123)
                         .numberOfCpuCoresRequired(123)
                         .build())
                 .container(InferenceComponentContainerSpecificationForInstanceTypeProperty.builder()
                         .artifactUrl("artifactUrl")
                         .containerMetricsConfig(ContainerMetricsConfigProperty.builder()
                                 .metricsEndpoints(List.of(MetricsEndpointProperty.builder()
                                         .metricsEndpointPath("metricsEndpointPath")
                                         // the properties below are optional
                                         .metricPublishFrequencyInSeconds(123)
                                         .build()))
                                 .build())
                         .environment(Map.of(
                                 "environmentKey", "environment"))
                         .image("image")
                         .build())
                 .currentDataCacheConfig(InferenceComponentDataCacheConfigProperty.builder()
                         .enableCaching(false)
                         .build())
                 .dataCacheConfig(InferenceComponentDataCacheConfigProperty.builder()
                         .enableCaching(false)
                         .build())
                 .modelName("modelName")
                 .schedulingConfig(InferenceComponentSchedulingConfigProperty.builder()
                         .availabilityZoneBalance(InferenceComponentAvailabilityZoneBalanceProperty.builder()
                                 .enforcementMode("enforcementMode")
                                 // the properties below are optional
                                 .maxImbalance(123)
                                 .build())
                         .placementStrategy("placementStrategy")
                         .build())
                 .startupParameters(InferenceComponentStartupParametersProperty.builder()
                         .containerStartupHealthCheckTimeoutInSeconds(123)
                         .modelDataDownloadTimeoutInSeconds(123)
                         .build())
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .variantName("variantName")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnInferenceComponentProps.Builder	A builder for CfnInferenceComponentProps
static final class	CfnInferenceComponentProps.Jsii$Proxy	An implementation for CfnInferenceComponentProps

Method Summary

Modifier and Type	Method	Description
static CfnInferenceComponentProps.Builder	builder()
default Object	getDeploymentConfig()	The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
default String	getEndpointArn()	The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.
String	getEndpointName()	The name of the endpoint that hosts the inference component.
default String	getInferenceComponentName()	The name of the inference component.
default Object	getRuntimeConfig()	The runtime config for the inference component.
default Object	getSpecification()	The specification for the inference component, for an endpoint with a single instance type.
default Object	getSpecifications()	A list of specification objects for the inference component, one per instance type.
default List<CfnTag>	getTags()	An array of tags to apply to the resource.
default String	getVariantName()	The name of the production variant that hosts the inference component.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEndpointName

@Stability(Stable)
@NotNull
String getEndpointName()

The name of the endpoint that hosts the inference component.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-endpointname

getDeploymentConfig

@Stability(Stable)
@Nullable
default Object getDeploymentConfig()

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

Returns union: either IResolvable or CfnInferenceComponent.InferenceComponentDeploymentConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-deploymentconfig

getEndpointArn

@Stability(Stable)
@Nullable
default String getEndpointArn()

The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-endpointarn

getInferenceComponentName

@Stability(Stable)
@Nullable
default String getInferenceComponentName()

The name of the inference component.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-inferencecomponentname

getRuntimeConfig

@Stability(Stable)
@Nullable
default Object getRuntimeConfig()

The runtime config for the inference component.

Returns union: either IResolvable or CfnInferenceComponent.InferenceComponentRuntimeConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-runtimeconfig

getSpecification

@Stability(Stable)
@Nullable
default Object getSpecification()

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.

Returns union: either IResolvable or CfnInferenceComponent.InferenceComponentSpecificationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-specification

getSpecifications

@Stability(Stable)
@Nullable
default Object getSpecifications()

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnInferenceComponent.InferenceComponentSpecificationForInstanceTypeProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-specifications

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of tags to apply to the resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-tags

getVariantName

@Stability(Stable)
@Nullable
default String getVariantName()

The name of the production variant that hosts the inference component.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-inferencecomponent.html#cfn-sagemaker-inferencecomponent-variantname

builder

@Stability(Stable)
static CfnInferenceComponentProps.Builder builder()

Returns:

a CfnInferenceComponentProps.Builder of CfnInferenceComponentProps