View a markdown version of this page

AWS::ElasticLoadBalancingV2::ListenerRule SourceIpConfig - AWS CloudFormation
SyntaxPropertiesExamples

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

AWS::ElasticLoadBalancingV2::ListenerRule SourceIpConfig

Information about a source IP condition.

You can use this condition to route based on the IP address of the source that connects to the load balancer. If a client is behind a proxy, this is the IP address of the proxy not the IP address of the client.

For Application Load Balancers, use Values to specify CIDR ranges. For Network Load Balancers, use IpAddressType to match on the IP address type of the source traffic.

Syntax

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

JSON

{
  "IpAddressType" : String,
  "Values" : [ String, ... ]
}

YAML

  IpAddressType: String
  Values: 
    - String

Properties

IpAddressType

Property description not available.

Required: No

Type: String

Update requires: No interruption

Values

The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.

If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header.

Required: No

Type: Array of String

Update requires: No interruption

Examples

The following example creates a listener rule with an action that forwards traffic to the specified target group when the specified source IP condition is met. You can create the target group using AWS::ElasticLoadBalancingV2::TargetGroup.

YAML

myListenerRule:
  Type: 'AWS::ElasticLoadBalancingV2::ListenerRule'
  Properties:
    Actions:
     - Type: forward
       TargetGroupArn: !Ref myTargetGroup
    Conditions:
     - Field: source-ip
       SourceIpConfig:
        Values:
         - 192.168.0.0/16

JSON

{
    "myListenerRule": {
        "Type": "AWS::ElasticLoadBalancingV2::ListenerRule",
        "Properties": {
            "Actions": [
                {
                    "Type": "forward",
                    "TargetGroupArn": {
                        "Ref": "myTargetGroup"
                    }
                }
            ],
            "Conditions": [
                {
                    "Field": "source-ip",
                    "SourceIpConfig": {
                        "Values": [
                            "192.168.0.0/24"
                        ]
                    }
                }
            ]
        }
    }
}