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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDeploymentGroup.LoadBalancerInfoProperty.Builder	A builder for CfnDeploymentGroup.LoadBalancerInfoProperty
static final class	CfnDeploymentGroup.LoadBalancerInfoProperty.Jsii$Proxy	An implementation for CfnDeploymentGroup.LoadBalancerInfoProperty

Method Summary

Modifier and Type	Method	Description
static CfnDeploymentGroup.LoadBalancerInfoProperty.Builder	builder()
default Object	getElbInfoList()	An array that contains information about the load balancers to use for load balancing in a deployment.
default Object	getTargetGroupInfoList()	An array that contains information about the target groups to use for load balancing in a deployment.
default Object	getTargetGroupPairInfoList()	The target group pair information.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getElbInfoList

@Stability(Stable)
@Nullable
default Object getElbInfoList()

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDeploymentGroup.ELBInfoProperty>

See Also:

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

getTargetGroupInfoList

@Stability(Stable)
@Nullable
default Object getTargetGroupInfoList()

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDeploymentGroup.TargetGroupInfoProperty>

See Also:

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

getTargetGroupPairInfoList

@Stability(Stable)
@Nullable
default Object getTargetGroupPairInfoList()

The target group pair information.

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDeploymentGroup.TargetGroupPairInfoProperty>

See Also:

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

builder

@Stability(Stable)
static CfnDeploymentGroup.LoadBalancerInfoProperty.Builder builder()

Returns:

a CfnDeploymentGroup.LoadBalancerInfoProperty.Builder of CfnDeploymentGroup.LoadBalancerInfoProperty