Amazon CodeDeploy · JSON Structure

Amazon Codedeploy Traffic Routing Config Structure

The configuration that specifies how traffic is shifted from one version of a Lambda function to another version during an Lambda deployment, or from one Amazon ECS task set to another during an Amazon ECS deployment.

Type: object Properties: 3
AmazonDeploymentDevOpsCI/CDRelease ManagementBlue/Green Deployment

TrafficRoutingConfig is a JSON Structure definition published by Amazon CodeDeploy, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

type timeBasedCanary timeBasedLinear

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codedeploy/refs/heads/main/json-structure/amazon-codedeploy-traffic-routing-config-structure.json",
  "name": "TrafficRoutingConfig",
  "description": "The configuration that specifies how traffic is shifted from one version of a Lambda function to another version during an Lambda deployment, or from one Amazon ECS task set to another during an Amazon ECS deployment.",
  "type": "object",
  "properties": {
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TrafficRoutingType"
        },
        {
          "description": "The type of traffic shifting (<code>TimeBasedCanary</code> or <code>TimeBasedLinear</code>) used by a deployment configuration."
        }
      ]
    },
    "timeBasedCanary": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeBasedCanary"
        },
        {
          "description": "A configuration that shifts traffic from one version of a Lambda function or 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."
        }
      ]
    },
    "timeBasedLinear": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeBasedLinear"
        },
        {
          "description": "A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions or Amazon ECS task sets are specified in the deployment's AppSpec file."
        }
      ]
    }
  }
}