Package software.amazon.awscdk.services.codedeploy

Interface CfnDeploymentGroup.LoadBalancerInfoProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDeploymentGroup.LoadBalancerInfoProperty.Jsii$Proxy
Enclosing class:
CfnDeploymentGroup
@Stability(Stable) public static interface CfnDeploymentGroup.LoadBalancerInfoProperty extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.codedeploy.*;
 LoadBalancerInfoProperty loadBalancerInfoProperty = LoadBalancerInfoProperty.builder()
         .elbInfoList(List.of(ELBInfoProperty.builder()
                 .name("name")
                 .build()))
         .targetGroupInfoList(List.of(TargetGroupInfoProperty.builder()
                 .name("name")
                 .build()))
         .targetGroupPairInfoList(List.of(TargetGroupPairInfoProperty.builder()
                 .prodTrafficRoute(TrafficRouteProperty.builder()
                         .listenerArns(List.of("listenerArns"))
                         .build())
                 .targetGroups(List.of(TargetGroupInfoProperty.builder()
                         .name("name")
                         .build()))
                 .testTrafficRoute(TrafficRouteProperty.builder()
                         .listenerArns(List.of("listenerArns"))
                         .build())
                 .build()))
         .build();

  • Method Details

    • getElbInfoList

      @Stability(Stable) @Nullable default Object getElbInfoList()
      An array that contains information about the load balancer to use for load balancing in a deployment.

      In Elastic Load Balancing, load balancers are used with Classic Load Balancers.

      Adding more than one load balancer to the array is not supported.

    • getTargetGroupInfoList

      @Stability(Stable) @Nullable default Object getTargetGroupInfoList()
      An array that contains information about the target group to use for load balancing in a deployment.

      In Elastic Load Balancing , target groups are used with Application Load Balancers .

      Adding more than one target group to the array is not supported.

    • getTargetGroupPairInfoList

      @Stability(Stable) @Nullable default Object getTargetGroupPairInfoList()
      CfnDeploymentGroup.LoadBalancerInfoProperty.TargetGroupPairInfoList.

    • builder

      @Stability(Stable) static CfnDeploymentGroup.LoadBalancerInfoProperty.Builder builder()
      Returns:
      a CfnDeploymentGroup.LoadBalancerInfoProperty.Builder of CfnDeploymentGroup.LoadBalancerInfoProperty