interface LoadBalancerInfoProperty

Language	Type name
.NET	`Amazon.CDK.AWS.CodeDeploy.CfnDeploymentGroup.LoadBalancerInfoProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscodedeploy#CfnDeploymentGroup_LoadBalancerInfoProperty`
Java	`software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup.LoadBalancerInfoProperty`
Python	`aws_cdk.aws_codedeploy.CfnDeploymentGroup.LoadBalancerInfoProperty`
TypeScript	`aws-cdk-lib` » `aws_codedeploy` » `CfnDeploymentGroup` » `LoadBalancerInfoProperty`

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 .

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

LoadBalancerInfo is a property of the DeploymentGroup resource.

Example

// 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 loadBalancerInfoProperty: codedeploy.CfnDeploymentGroup.LoadBalancerInfoProperty = {
  elbInfoList: [{
    name: 'name',
  }],
  targetGroupInfoList: [{
    name: 'name',
  }],
  targetGroupPairInfoList: [{
    prodTrafficRoute: {
      listenerArns: ['listenerArns'],
    },
    targetGroups: [{
      name: 'name',
    }],
    testTrafficRoute: {
      listenerArns: ['listenerArns'],
    },
  }],
};

Properties

Name	Type	Description
elbInfoList?	`IResolvable` `\| (IResolvable` `\|` `ELBInfoProperty)[]`	An array that contains information about the load balancers to use for load balancing in a deployment.
targetGroupInfoList?	`IResolvable` `\| (IResolvable` `\|` `TargetGroupInfoProperty)[]`	An array that contains information about the target groups to use for load balancing in a deployment.
targetGroupPairInfoList?	`IResolvable` `\| (IResolvable` `\|` `TargetGroupPairInfoProperty)[]`	The target group pair information.

elbInfoList?

Type: IResolvable | (IResolvable | ELBInfoProperty)[] (optional)

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.

You can add up to 10 load balancers to the array. > If you're using Application Load Balancers or Network Load Balancers, use the targetGroupInfoList array instead of this one.

targetGroupInfoList?

Type: IResolvable | (IResolvable | TargetGroupInfoProperty)[] (optional)

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.

You can add up to 10 target groups to the array. > If you're using Classic Load Balancers, use the elbInfoList array instead of this one.

targetGroupPairInfoList?

Type: IResolvable | (IResolvable | TargetGroupPairInfoProperty)[] (optional)

The target group pair information.

This is an array of TargeGroupPairInfo objects with a maximum size of one.