AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateRule operation. Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.

Each rule consists of a priority, one or more actions, and one or more conditions. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener rules in the Application Load Balancers Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ElasticLoadBalancingV2.AmazonElasticLoadBalancingV2Request
      Amazon.ElasticLoadBalancingV2.Model.CreateRuleRequest

Namespace: Amazon.ElasticLoadBalancingV2.Model
Assembly: AWSSDK.ElasticLoadBalancingV2.dll
Version: 3.x.y.z

Syntax

C#
public class CreateRuleRequest : AmazonElasticLoadBalancingV2Request
         IAmazonWebServiceRequest

The CreateRuleRequest type exposes the following members

Constructors

NameDescription
Public Method CreateRuleRequest()

Properties

NameTypeDescription
Public Property Actions System.Collections.Generic.List<Amazon.ElasticLoadBalancingV2.Model.Action>

Gets and sets the property Actions.

The actions.

Public Property Conditions System.Collections.Generic.List<Amazon.ElasticLoadBalancingV2.Model.RuleCondition>

Gets and sets the property Conditions.

The conditions.

Public Property ListenerArn System.String

Gets and sets the property ListenerArn.

The Amazon Resource Name (ARN) of the listener.

Public Property Priority System.Int32

Gets and sets the property Priority.

The rule priority. A listener can't have multiple rules with the same priority.

Public Property Tags System.Collections.Generic.List<Amazon.ElasticLoadBalancingV2.Model.Tag>

Gets and sets the property Tags.

The tags to assign to the rule.

Examples

This example creates a rule that forwards requests to the specified target group if the URL contains the specified pattern (for example, /img/*).

To create a rule


var client = new AmazonElasticLoadBalancingV2Client();
var response = client.CreateRule(new CreateRuleRequest 
{
    Actions = new List<Action> {
        new Action {
            TargetGroupArn = "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
            Type = "forward"
        }
    },
    Conditions = new List<RuleCondition> {
        new RuleCondition {
            Field = "path-pattern",
            Values = new List<string> {
                "/img/*"
            }
        }
    },
    ListenerArn = "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2",
    Priority = 10
});

List<Rule> rules = response.Rules;

            

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5