AWS::CodeDeploy::DeploymentGroup LoadBalancerInfo

The LoadBalancerInfo property type specifies information about the load balancer or target group used for an AWS CodeDeploy deployment group. For more information, see Integrating CodeDeploy with Elastic Load Balancing in the AWS CodeDeploy User Guide.

For AWS CloudFormation to use the properties specified in LoadBalancerInfo, the DeploymentStyle.DeploymentOption property must be set to WITH_TRAFFIC_CONTROL. If DeploymentStyle.DeploymentOption is not set to WITH_TRAFFIC_CONTROL, AWS CloudFormation ignores any settings specified in LoadBalancerInfo.

Note

AWS CloudFormation supports blue/green deployments on the AWS Lambda compute platform only.

LoadBalancerInfo is a property of the DeploymentGroup resource.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "ElbInfoList" : [ ELBInfo, ... ],
  "TargetGroupInfoList" : [ TargetGroupInfo, ... ],
  "TargetGroupPairInfoList" : [ TargetGroupPairInfo, ... ]
}

YAML

  ElbInfoList: 
    - ELBInfo
  TargetGroupInfoList: 
    - TargetGroupInfo
  TargetGroupPairInfoList: 
    - TargetGroupPairInfo

Properties

ElbInfoList

An array that contains information about the load balancers to use for load balancing in a deployment. If you're using Classic Load Balancers, specify those load balancers in this array.

Note

You can add up to 10 load balancers to the array.

Note

If you're using Application Load Balancers or Network Load Balancers, use the targetGroupInfoList array instead of this one.

Required: No

Type: Array of ELBInfo

Update requires: No interruption

TargetGroupInfoList

An array that contains information about the target groups to use for load balancing in a deployment. If you're using Application Load Balancers and Network Load Balancers, specify their associated target groups in this array.

Note

You can add up to 10 target groups to the array.

Note

If you're using Classic Load Balancers, use the elbInfoList array instead of this one.

Required: Conditional

Type: Array of TargetGroupInfo

Update requires: No interruption

TargetGroupPairInfoList

The target group pair information. This is an array of TargeGroupPairInfo objects with a maximum size of one.

Required: No

Type: Array of TargetGroupPairInfo

Update requires: No interruption