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)
CreateRuleRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
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

equalsBySdkFields, 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 rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.

Parameters:

conditions - The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.

Returns:

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

conditions

CreateRuleRequest.Builder conditions(RuleCondition... conditions)

The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.

Parameters:

conditions - The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.

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 rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.

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, and it must be the last action to be performed.

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

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

[HTTPS listeners] 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, and it must be the last action to be performed.

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

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

[HTTPS listeners] 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, and it must be the last action to be performed.

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

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

[HTTPS listeners] 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, and it must be the last action to be performed.

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

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

[HTTPS listeners] 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, and it must be the last action to be performed.

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

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

[HTTPS listeners] 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)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder