AWS CDK Reference

Appearance

v2.277.0

CfnTrafficRoutingConfig Struct ​

Traffic routing configuration settings.

The type of the CfnCodeDeployBlueGreenHookProps.trafficRoutingConfig property.

Source
core/lib/cfn-codedeploy-blue-green-hook.ts

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const cfnTrafficRoutingConfig: cdk.CfnTrafficRoutingConfig = {
  type: cdk.CfnTrafficRoutingType.ALL_AT_ONCE,

  // the properties below are optional
  timeBasedCanary: {
    bakeTimeMins: 123,
    stepPercentage: 123,
  },
  timeBasedLinear: {
    bakeTimeMins: 123,
    stepPercentage: 123,
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk

cfn_traffic_routing_config = cdk.CfnTrafficRoutingConfig(
    type=cdk.CfnTrafficRoutingType.ALL_AT_ONCE,

    # the properties below are optional
    time_based_canary=cdk.CfnTrafficRoutingTimeBasedCanary(
        bake_time_mins=123,
        step_percentage=123
    ),
    time_based_linear=cdk.CfnTrafficRoutingTimeBasedLinear(
        bake_time_mins=123,
        step_percentage=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.*;

CfnTrafficRoutingConfig cfnTrafficRoutingConfig = CfnTrafficRoutingConfig.builder()
        .type(CfnTrafficRoutingType.ALL_AT_ONCE)

        // the properties below are optional
        .timeBasedCanary(CfnTrafficRoutingTimeBasedCanary.builder()
                .bakeTimeMins(123)
                .stepPercentage(123)
                .build())
        .timeBasedLinear(CfnTrafficRoutingTimeBasedLinear.builder()
                .bakeTimeMins(123)
                .stepPercentage(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;

var cfnTrafficRoutingConfig = new CfnTrafficRoutingConfig {
    Type = CfnTrafficRoutingType.ALL_AT_ONCE,

    // the properties below are optional
    TimeBasedCanary = new CfnTrafficRoutingTimeBasedCanary {
        BakeTimeMins = 123,
        StepPercentage = 123
    },
    TimeBasedLinear = new CfnTrafficRoutingTimeBasedLinear {
        BakeTimeMins = 123,
        StepPercentage = 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 cdk "github.com/aws/aws-cdk-go/awscdk"

cfnTrafficRoutingConfig := &CfnTrafficRoutingConfig{
	Type: cdk.CfnTrafficRoutingType_ALL_AT_ONCE,

	// the properties below are optional
	TimeBasedCanary: &CfnTrafficRoutingTimeBasedCanary{
		BakeTimeMins: jsii.Number(123),
		StepPercentage: jsii.Number(123),
	},
	TimeBasedLinear: &CfnTrafficRoutingTimeBasedLinear{
		BakeTimeMins: jsii.Number(123),
		StepPercentage: jsii.Number(123),
	},
}

Properties ​

timeBasedCanaryoptionalCfnTrafficRoutingTimeBasedCanarytime_based_canaryoptionalCfnTrafficRoutingTimeBasedCanarytimeBasedCanaryoptionalCfnTrafficRoutingTimeBasedCanaryTimeBasedCanaryoptionalCfnTrafficRoutingTimeBasedCanaryTimeBasedCanaryoptionalCfnTrafficRoutingTimeBasedCanary= none#
The configuration for traffic routing when `type` is `CfnTrafficRoutingType.TIME_BASED_CANARY`.
timeBasedLinearoptionalCfnTrafficRoutingTimeBasedLineartime_based_linearoptionalCfnTrafficRoutingTimeBasedLineartimeBasedLinearoptionalCfnTrafficRoutingTimeBasedLinearTimeBasedLinearoptionalCfnTrafficRoutingTimeBasedLinearTimeBasedLinearoptionalCfnTrafficRoutingTimeBasedLinear= none#
The configuration for traffic routing when `type` is `CfnTrafficRoutingType.TIME_BASED_LINEAR`.
typeCfnTrafficRoutingTypetypeCfnTrafficRoutingTypetypeCfnTrafficRoutingTypeTypeCfnTrafficRoutingTypeTypeCfnTrafficRoutingTyperequired#
The type of traffic shifting used by the blue-green deployment configuration.