interface TrafficRoutingConfigProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Sagemaker.CfnEndpoint.TrafficRoutingConfigProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnEndpoint_TrafficRoutingConfigProperty`
Java	`software.amazon.awscdk.services.sagemaker.CfnEndpoint.TrafficRoutingConfigProperty`
Python	`aws_cdk.aws_sagemaker.CfnEndpoint.TrafficRoutingConfigProperty`
TypeScript	`aws-cdk-lib` » `aws_sagemaker` » `CfnEndpoint` » `TrafficRoutingConfigProperty`

Defines the traffic routing strategy during an endpoint deployment to shift traffic from the old fleet to the new fleet.

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 trafficRoutingConfigProperty: sagemaker.CfnEndpoint.TrafficRoutingConfigProperty = {
  type: 'type',

  // the properties below are optional
  canarySize: {
    type: 'type',
    value: 123,
  },
  linearStepSize: {
    type: 'type',
    value: 123,
  },
  waitIntervalInSeconds: 123,
};

Properties

Name	Type	Description
type	`string`	Traffic routing strategy type.
canarySize?	`IResolvable` `\|` `CapacitySizeProperty`	Batch size for the first step to turn on traffic on the new endpoint fleet.
linearStepSize?	`IResolvable` `\|` `CapacitySizeProperty`	Batch size for each step to turn on traffic on the new endpoint fleet.
waitIntervalInSeconds?	`number`	The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.

type

Type: string

Traffic routing strategy type.

ALL_AT_ONCE : Endpoint traffic shifts to the new fleet in a single step.
CANARY : Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic.
LINEAR : Endpoint traffic shifts to the new fleet in n steps of a configurable size.

canarySize?

Type: IResolvable | CapacitySizeProperty (optional)

Batch size for the first step to turn on traffic on the new endpoint fleet.

Value must be less than or equal to 50% of the variant's total instance count.

linearStepSize?

Type: IResolvable | CapacitySizeProperty (optional)

Batch size for each step to turn on traffic on the new endpoint fleet.

Value must be 10-50% of the variant's total instance count.

waitIntervalInSeconds?

Type: number (optional)

The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.