software.amazon.awssdk.services.elasticloadbalancingv2.model

Class CreateRuleRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.elasticloadbalancingv2.model.ElasticLoadBalancingV2Request

software.amazon.awssdk.services.elasticloadbalancingv2.model.CreateRuleRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateRuleRequest.Builder,CreateRuleRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateRuleRequest
extends ElasticLoadBalancingV2Request
implements ToCopyableBuilder<CreateRuleRequest.Builder,CreateRuleRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateRuleRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<Action>	actions() The actions.
static CreateRuleRequest.Builder	builder()
List<RuleCondition>	conditions() The conditions.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	listenerArn() The Amazon Resource Name (ARN) of the listener.
Integer	priority() The rule priority.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateRuleRequest.Builder>	serializableBuilderClass()
CreateRuleRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

listenerArn

public String listenerArn()

The Amazon Resource Name (ARN) of the listener.

Returns:

The Amazon Resource Name (ARN) of the listener.

conditions

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

priority

public Integer priority()

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

Returns:

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

actions

public List<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. 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

toBuilder

public CreateRuleRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateRuleRequest.Builder,CreateRuleRequest>

Specified by:

toBuilder in class ElasticLoadBalancingV2Request

builder

public static CreateRuleRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateRuleRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo