Skip to content
v2.277.0

TimeBasedCanaryProperty Struct ​

A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in two increments.

The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file.

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 timeBasedCanaryProperty: codedeploy.CfnDeploymentConfig.TimeBasedCanaryProperty = {
  canaryInterval: 123,
  canaryPercentage: 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_codedeploy as codedeploy

time_based_canary_property = codedeploy.CfnDeploymentConfig.TimeBasedCanaryProperty(
    canary_interval=123,
    canary_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.services.codedeploy.*;

TimeBasedCanaryProperty timeBasedCanaryProperty = TimeBasedCanaryProperty.builder()
        .canaryInterval(123)
        .canaryPercentage(123)
        .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.CodeDeploy;

var timeBasedCanaryProperty = new TimeBasedCanaryProperty {
    CanaryInterval = 123,
    CanaryPercentage = 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"

timeBasedCanaryProperty := &TimeBasedCanaryProperty{
	CanaryInterval: jsii.Number(123),
	CanaryPercentage: jsii.Number(123),
}

Properties ​

canaryIntervalnumbercanary_intervalint | floatcanaryIntervalNumberCanaryIntervaldoubleCanaryInterval*float64required#
The number of minutes between the first and second traffic shifts of a `TimeBasedCanary` deployment.
canaryPercentagenumbercanary_percentageint | floatcanaryPercentageNumberCanaryPercentagedoubleCanaryPercentage*float64required#
The percentage of traffic to shift in the first increment of a `TimeBasedCanary` deployment.