You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ElasticLoadBalancingV2::Types::CreateRuleInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb

Overview

Note:

When making an API call, you may pass CreateRuleInput data as a hash:

{
  listener_arn: "ListenerArn", # required
  conditions: [ # required
    {
      field: "ConditionFieldName",
      values: ["StringValue"],
    },
  ],
  priority: 1, # required
  actions: [ # required
    {
      type: "forward", # required, accepts forward
      target_group_arn: "TargetGroupArn", # required
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#actionsArray<Types::Action>

An action. Each action has the type forward and specifies a target group.

Returns:



439
440
441
442
443
444
445
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 439

class CreateRuleInput < Struct.new(
  :listener_arn,
  :conditions,
  :priority,
  :actions)
  include Aws::Structure
end

#conditionsArray<Types::RuleCondition>

The conditions. Each condition specifies a field name and a single value.

If the field name is host-header, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.

  • A-Z, a-z, 0-9

  • - .

    • (matches 0 or more characters)
  • ? (matches exactly 1 character)

If the field name is path-pattern, you can specify a single path pattern. A path pattern is case sensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.

  • A-Z, a-z, 0-9

  • _ - . $ / ~ " ' @ : +

  • & (using &amp;)

    • (matches 0 or more characters)
  • ? (matches exactly 1 character)

Returns:



439
440
441
442
443
444
445
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 439

class CreateRuleInput < Struct.new(
  :listener_arn,
  :conditions,
  :priority,
  :actions)
  include Aws::Structure
end

#listener_arnString

The Amazon Resource Name (ARN) of the listener.

Returns:

  • (String)


439
440
441
442
443
444
445
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 439

class CreateRuleInput < Struct.new(
  :listener_arn,
  :conditions,
  :priority,
  :actions)
  include Aws::Structure
end

#priorityInteger

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

Returns:

  • (Integer)


439
440
441
442
443
444
445
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 439

class CreateRuleInput < Struct.new(
  :listener_arn,
  :conditions,
  :priority,
  :actions)
  include Aws::Structure
end