Interface CfnDeploymentGroup.ILoadBalancerInfoProperty
The LoadBalancerInfo
property type specifies information about the load balancer or target group used for an AWS CodeDeploy deployment group.
Namespace: Amazon.CDK.AWS.CodeDeploy
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ILoadBalancerInfoProperty
Syntax (vb)
Public Interface ILoadBalancerInfoProperty
Remarks
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.
ExampleMetadata: fixture=_generated
Examples
// 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 loadBalancerInfoProperty = new LoadBalancerInfoProperty {
ElbInfoList = new [] { new ELBInfoProperty {
Name = "name"
} },
TargetGroupInfoList = new [] { new TargetGroupInfoProperty {
Name = "name"
} },
TargetGroupPairInfoList = new [] { new TargetGroupPairInfoProperty {
ProdTrafficRoute = new TrafficRouteProperty {
ListenerArns = new [] { "listenerArns" }
},
TargetGroups = new [] { new TargetGroupInfoProperty {
Name = "name"
} },
TestTrafficRoute = new TrafficRouteProperty {
ListenerArns = new [] { "listenerArns" }
}
} }
};
Synopsis
Properties
ElbInfoList | An array that contains information about the load balancers to use for load balancing in a deployment. |
TargetGroupInfoList | An array that contains information about the target groups to use for load balancing in a deployment. |
TargetGroupPairInfoList | The target group pair information. |
Properties
ElbInfoList
An array that contains information about the load balancers to use for load balancing in a deployment.
virtual object ElbInfoList { get; }
Property Value
System.Object
Remarks
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
An array that contains information about the target groups to use for load balancing in a deployment.
virtual object TargetGroupInfoList { get; }
Property Value
System.Object
Remarks
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
The target group pair information.
virtual object TargetGroupPairInfoList { get; }
Property Value
System.Object
Remarks
This is an array of TargeGroupPairInfo
objects with a maximum size of one.