software.amazon.awssdk.services.elasticloadbalancingv2.model

Interface CreateRuleRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateRuleRequest.Builder,CreateRuleRequest>, ElasticLoadBalancingV2Request.Builder, SdkBuilder<CreateRuleRequest.Builder,CreateRuleRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateRuleRequest

public static interface CreateRuleRequest.Builder
extends ElasticLoadBalancingV2Request.Builder, SdkPojo, CopyableBuilder<CreateRuleRequest.Builder,CreateRuleRequest>

Method Summary

Modifier and Type	Method and Description
CreateRuleRequest.Builder	actions(Action... actions) The actions.
CreateRuleRequest.Builder	actions(Collection<Action> actions) The actions.
CreateRuleRequest.Builder	actions(Consumer<Action.Builder>... actions) The actions.
CreateRuleRequest.Builder	conditions(Collection<RuleCondition> conditions) The conditions.
CreateRuleRequest.Builder	conditions(Consumer<RuleCondition.Builder>... conditions) The conditions.
CreateRuleRequest.Builder	conditions(RuleCondition... conditions) The conditions.
CreateRuleRequest.Builder	listenerArn(String listenerArn) The Amazon Resource Name (ARN) of the listener.
CreateRuleRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateRuleRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateRuleRequest.Builder	priority(Integer priority) The rule priority.

Methods inherited from interface software.amazon.awssdk.services.elasticloadbalancingv2.model.ElasticLoadBalancingV2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

listenerArn

CreateRuleRequest.Builder listenerArn(String listenerArn)

The Amazon Resource Name (ARN) of the listener.

Parameters:

listenerArn - The Amazon Resource Name (ARN) of the listener.

Returns:

Returns a reference to this object so that method calls can be chained together.

conditions

CreateRuleRequest.Builder conditions(Collection<RuleCondition> conditions)

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. 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. 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)

Parameters:

conditions - 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. 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. 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:

Returns a reference to this object so that method calls can be chained together.

conditions

CreateRuleRequest.Builder conditions(RuleCondition... conditions)

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. 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. 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)

Parameters:

conditions - 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. 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. 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:

Returns a reference to this object so that method calls can be chained together.

conditions

CreateRuleRequest.Builder conditions(Consumer<RuleCondition.Builder>... conditions)

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. 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. 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)

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #conditions(List).

Parameters:

conditions - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#conditions(List)

priority

CreateRuleRequest.Builder priority(Integer priority)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

actions

CreateRuleRequest.Builder actions(Collection<Action> actions)

The actions. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect.

If the action type is forward, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.

[HTTPS listener] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.

[HTTPS listener] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito.

[Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another.

[Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.

Parameters:

actions - The actions. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect.

If the action type is forward, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.

[HTTPS listener] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.

[HTTPS listener] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito.

[Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another.

[Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.

Returns:

Returns a reference to this object so that method calls can be chained together.

actions

CreateRuleRequest.Builder actions(Action... actions)

The actions. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect.

If the action type is forward, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.

[HTTPS listener] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.

[HTTPS listener] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito.

[Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another.

[Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.

Parameters:

actions - The actions. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect.

If the action type is forward, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.

[HTTPS listener] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.

[HTTPS listener] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito.

[Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another.

[Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.

Returns:

Returns a reference to this object so that method calls can be chained together.

actions

CreateRuleRequest.Builder actions(Consumer<Action.Builder>... actions)

The actions. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect.

If the action type is forward, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.

[HTTPS listener] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.

[HTTPS listener] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito.

[Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another.

[Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #actions(List).

Parameters:

actions - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#actions(List)

overrideConfiguration

CreateRuleRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateRuleRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.