Skip to content
v2.278.0

InferenceComponentDeploymentConfigProperty Struct ​

The deployment configuration for an endpoint that hosts inference components.

The configuration includes the desired deployment strategy and rollback settings.

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 inferenceComponentDeploymentConfigProperty: sagemaker.CfnInferenceComponent.InferenceComponentDeploymentConfigProperty = {
  autoRollbackConfiguration: {
    alarms: [{
      alarmName: 'alarmName',
    }],
  },
  rollingUpdatePolicy: {
    maximumBatchSize: {
      type: 'type',
      value: 123,
    },
    maximumExecutionTimeoutInSeconds: 123,
    rollbackMaximumBatchSize: {
      type: 'type',
      value: 123,
    },
    waitIntervalInSeconds: 123,
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

inference_component_deployment_config_property = sagemaker.CfnInferenceComponent.InferenceComponentDeploymentConfigProperty(
    auto_rollback_configuration=sagemaker.CfnInferenceComponent.AutoRollbackConfigurationProperty(
        alarms=[sagemaker.CfnInferenceComponent.AlarmProperty(
            alarm_name="alarmName"
        )]
    ),
    rolling_update_policy=sagemaker.CfnInferenceComponent.InferenceComponentRollingUpdatePolicyProperty(
        maximum_batch_size=sagemaker.CfnInferenceComponent.InferenceComponentCapacitySizeProperty(
            type="type",
            value=123
        ),
        maximum_execution_timeout_in_seconds=123,
        rollback_maximum_batch_size=sagemaker.CfnInferenceComponent.InferenceComponentCapacitySizeProperty(
            type="type",
            value=123
        ),
        wait_interval_in_seconds=123
    )
)
java
// 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.*;

InferenceComponentDeploymentConfigProperty inferenceComponentDeploymentConfigProperty = 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;

var inferenceComponentDeploymentConfigProperty = new InferenceComponentDeploymentConfigProperty {
    AutoRollbackConfiguration = new AutoRollbackConfigurationProperty {
        Alarms = new [] { new AlarmProperty {
            AlarmName = "alarmName"
        } }
    },
    RollingUpdatePolicy = new InferenceComponentRollingUpdatePolicyProperty {
        MaximumBatchSize = new InferenceComponentCapacitySizeProperty {
            Type = "type",
            Value = 123
        },
        MaximumExecutionTimeoutInSeconds = 123,
        RollbackMaximumBatchSize = new InferenceComponentCapacitySizeProperty {
            Type = "type",
            Value = 123
        },
        WaitIntervalInSeconds = 123
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

inferenceComponentDeploymentConfigProperty := &InferenceComponentDeploymentConfigProperty{
	AutoRollbackConfiguration: &AutoRollbackConfigurationProperty{
		Alarms: []interface{}{
			&AlarmProperty{
				AlarmName: jsii.String("alarmName"),
			},
		},
	},
	RollingUpdatePolicy: &InferenceComponentRollingUpdatePolicyProperty{
		MaximumBatchSize: &InferenceComponentCapacitySizeProperty{
			Type: jsii.String("type"),
			Value: jsii.Number(123),
		},
		MaximumExecutionTimeoutInSeconds: jsii.Number(123),
		RollbackMaximumBatchSize: &InferenceComponentCapacitySizeProperty{
			Type: jsii.String("type"),
			Value: jsii.Number(123),
		},
		WaitIntervalInSeconds: jsii.Number(123),
	},
}

Properties ​

autoRollbackConfigurationoptionalIResolvable | CfnInferenceComponent.AutoRollbackConfigurationPropertyauto_rollback_configurationoptionaltyping.Union[IResolvable, AutoRollbackConfigurationProperty]autoRollbackConfigurationoptionalIResolvableAutoRollbackConfigurationoptionalIResolvableAutoRollbackConfigurationoptionalinterface{} #
rollingUpdatePolicyoptionalIResolvable | CfnInferenceComponent.InferenceComponentRollingUpdatePolicyPropertyrolling_update_policyoptionaltyping.Union[IResolvable, InferenceComponentRollingUpdatePolicyProperty]rollingUpdatePolicyoptionalIResolvableRollingUpdatePolicyoptionalIResolvableRollingUpdatePolicyoptionalinterface{} #
Specifies a rolling deployment strategy for updating a SageMaker AI endpoint.