AWS::ElasticLoadBalancingV2::ListenerRule ForwardConfig - Amazon CloudFormation
SyntaxPropertiesExamples
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::ElasticLoadBalancingV2::ListenerRule ForwardConfig

Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

Properties

TargetGroups

Information about how traffic will be distributed between multiple target groups in a forward rule.

Required: No

Type: Array of TargetGroupTuple

Update requires: No interruption

TargetGroupStickinessConfig

Information about the target group stickiness for a rule.

Required: No

Type: TargetGroupStickinessConfig

Update requires: No interruption

Examples

The following example sets the relative weight of traffic between two traffic groups. Because the weight property of each group is set to the same value, 1, traffic is split 50/50 between the two target groups. You can create the target group using AWS::ElasticLoadBalancingV2::TargetGroup.

YAML

myListenerRule:
  Type: 'AWS::ElasticLoadBalancingV2::ListenerRule'
  Properties:
    Actions:
      - Type: forward
        ForwardConfig:
          TargetGroups:
            - TargetGroupArn: !Ref TargetGroup1
              Weight: 1
            - TargetGroupArn: !Ref TargetGroup2
              Weight: 1
    Conditions:
      - Field: path-pattern
        Values:
          - test
    ListenerArn: !Ref Listener
    Priority: 10

JSON

{
    "myListenerRule": {
        "Type": "AWS::ElasticLoadBalancingV2::ListenerRule",
        "Properties": {
            "Actions": [
                {
                    "Type": "forward",
                    "ForwardConfig": {
                        "TargetGroups": [
                            {
                                "TargetGroupArn": {
                                    "Ref": "TargetGroup1"
                                },
                                "Weight": 1
                            },
                            {
                                "TargetGroupArn": {
                                    "Ref": "TargetGroup2"
                                },
                                "Weight": 1
                            }
                        ]
                    }
                }
            ],
            "Conditions": [
                {
                    "Field": "path-pattern",
                    "Values": [
                        "test"
                    ]
                }
            ],
            "ListenerArn": {
                "Ref": "Listener"
            },
            "Priority": 10
        }
    }
}