Interface CfnDeploymentGroupPropsMixin.ILoadBalancerInfoProperty

The LoadBalancerInfo property type specifies information about the load balancer or target group used for an AWS CodeDeploy deployment group.

Namespace: Amazon.CDK.Mixins.Preview.AWS.CodeDeploy.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public interface CfnDeploymentGroupPropsMixin.ILoadBalancerInfoProperty

Syntax (vb)

Public Interface CfnDeploymentGroupPropsMixin.ILoadBalancerInfoProperty

Remarks

For more information, see Integrating CodeDeploy with ELB in the AWS CodeDeploy User Guide .

For 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 , CloudFormation ignores any settings specified in LoadBalancerInfo .

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

LoadBalancerInfo is a property of the DeploymentGroup resource.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html

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.Mixins.Preview.AWS.CodeDeploy.Mixins;

             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.

object? ElbInfoList { get; }

Property Value

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 <code>targetGroupInfoList</code> array instead of this one.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html#cfn-codedeploy-deploymentgroup-loadbalancerinfo-elbinfolist

Type union: either IResolvable or (either IResolvable or CfnDeploymentGroupPropsMixin.IELBInfoProperty)[]

TargetGroupInfoList

An array that contains information about the target groups to use for load balancing in a deployment.

object? TargetGroupInfoList { get; }

Property Value

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 <code>elbInfoList</code> array instead of this one.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html#cfn-codedeploy-deploymentgroup-loadbalancerinfo-targetgroupinfolist

Type union: either IResolvable or (either IResolvable or CfnDeploymentGroupPropsMixin.ITargetGroupInfoProperty)[]

TargetGroupPairInfoList

The target group pair information.

object? TargetGroupPairInfoList { get; }

Property Value

object

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html#cfn-codedeploy-deploymentgroup-loadbalancerinfo-targetgrouppairinfolist

Type union: either IResolvable or (either IResolvable or CfnDeploymentGroupPropsMixin.ITargetGroupPairInfoProperty)[]