AWS CDK Reference

Appearance

v2.273.0

TimeBasedLinearTrafficRouting Class ​

Define a traffic routing config of type 'TimeBasedLinear'.

Source
aws-codedeploy/lib/traffic-routing-config.ts
Type last changed
v2.45.0 · 6 Oct 2022

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codedeploy as codedeploy } from 'aws-cdk-lib';
const timeBasedLinearTrafficRouting = codedeploy.TimeBasedLinearTrafficRouting.allAtOnce();
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_codedeploy as codedeploy

time_based_linear_traffic_routing = codedeploy.TimeBasedLinearTrafficRouting.all_at_once()
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.codedeploy.*;

TrafficRouting timeBasedLinearTrafficRouting = TimeBasedLinearTrafficRouting.allAtOnce();
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.CodeDeploy;

var timeBasedLinearTrafficRouting = TimeBasedLinearTrafficRouting.AllAtOnce();
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"

timeBasedLinearTrafficRouting := awscdk.Aws_codedeploy.TimeBasedLinearTrafficRouting_AllAtOnce()

Initializer ​

ts
new TimeBasedLinearTrafficRouting(props: TimeBasedLinearTrafficRoutingProps)
python
TimeBasedLinearTrafficRouting(props: TimeBasedLinearTrafficRoutingProps)
java
new TimeBasedLinearTrafficRouting(TimeBasedLinearTrafficRoutingProps props)
csharp
new TimeBasedLinearTrafficRouting(TimeBasedLinearTrafficRoutingProps props)
go
NewTimeBasedLinearTrafficRouting(Props TimeBasedLinearTrafficRoutingProps)

Properties ​

intervalDurationintervalDurationintervalDurationIntervalDurationIntervalDurationrequired#
The amount of time between additional traffic shifts.
percentagenumberpercentageint | floatpercentageNumberPercentagedoublePercentage*float64required#
The percentage to increase traffic on each traffic shift.

Methods ​

allAtOnce(): TrafficRouting@staticmethod def all_at_once() -> TrafficRoutingpublic static TrafficRouting allAtOnce()public static TrafficRouting AllAtOnce()func AllAtOnce() TrafficRoutingstatic#
Shifts 100% of traffic in a single shift.
bind(_scope: Construct): TrafficRoutingConfigdef bind(self, _scope: Construct) -> TrafficRoutingConfigpublic TrafficRoutingConfig bind(Construct _scope)public TrafficRoutingConfig Bind(Construct _scope)func Bind(_scope Construct) TrafficRoutingConfig#
Return a TrafficRoutingConfig of type `TimeBasedLinear`.
timeBasedCanary(props: TimeBasedCanaryTrafficRoutingProps): TrafficRouting@staticmethod def time_based_canary(props: TimeBasedCanaryTrafficRoutingProps) -> TrafficRoutingpublic static TrafficRouting timeBasedCanary(TimeBasedCanaryTrafficRoutingProps props)public static TrafficRouting TimeBasedCanary(TimeBasedCanaryTrafficRoutingProps props)func TimeBasedCanary(Props TimeBasedCanaryTrafficRoutingProps) TrafficRoutingstatic#
Shifts a specified percentage of traffic, waits for a specified amount of time, then shifts the rest of traffic.
timeBasedLinear(props: TimeBasedLinearTrafficRoutingProps): TrafficRouting@staticmethod def time_based_linear(props: TimeBasedLinearTrafficRoutingProps) -> TrafficRoutingpublic static TrafficRouting timeBasedLinear(TimeBasedLinearTrafficRoutingProps props)public static TrafficRouting TimeBasedLinear(TimeBasedLinearTrafficRoutingProps props)func TimeBasedLinear(Props TimeBasedLinearTrafficRoutingProps) TrafficRoutingstatic#
Keeps shifting a specified percentage of traffic until reaching 100%, waiting for a specified amount of time in between each traffic shift.