com.amazonaws.services.elasticloadbalancingv2.model

Class CreateRuleRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticloadbalancingv2.model.CreateRuleRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateRuleRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateRuleRequest()

Method Summary

Modifier and Type	Method and Description
CreateRuleRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<Action>	getActions() The actions.
List<RuleCondition>	getConditions() The conditions.
String	getListenerArn() The Amazon Resource Name (ARN) of the listener.
Integer	getPriority() The rule priority.
int	hashCode()
void	setActions(Collection<Action> actions) The actions.
void	setConditions(Collection<RuleCondition> conditions) The conditions.
void	setListenerArn(String listenerArn) The Amazon Resource Name (ARN) of the listener.
void	setPriority(Integer priority) The rule priority.
String	toString() Returns a string representation of this object.
CreateRuleRequest	withActions(Action... actions) The actions.
CreateRuleRequest	withActions(Collection<Action> actions) The actions.
CreateRuleRequest	withConditions(Collection<RuleCondition> conditions) The conditions.
CreateRuleRequest	withConditions(RuleCondition... conditions) The conditions.
CreateRuleRequest	withListenerArn(String listenerArn) The Amazon Resource Name (ARN) of the listener.
CreateRuleRequest	withPriority(Integer priority) The rule priority.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateRuleRequest

public CreateRuleRequest()

Method Detail

setListenerArn

public void setListenerArn(String listenerArn)

The Amazon Resource Name (ARN) of the listener.

Parameters:

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

getListenerArn

public String getListenerArn()

The Amazon Resource Name (ARN) of the listener.

Returns:

The Amazon Resource Name (ARN) of the listener.

withListenerArn

public CreateRuleRequest withListenerArn(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.

getConditions

public List<RuleCondition> getConditions()

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

• * (matches 0 or more characters)

• ? (matches exactly 1 character)

Returns:

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

• (matches 0 or more characters)

• ? (matches exactly 1 character)

setConditions

public void setConditions(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 &)

• * (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 &)

• (matches 0 or more characters)

• ? (matches exactly 1 character)

withConditions

public CreateRuleRequest withConditions(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 &)

• * (matches 0 or more characters)

• ? (matches exactly 1 character)

NOTE: This method appends the values to the existing list (if any). Use setConditions(java.util.Collection) or withConditions(java.util.Collection) if you want to override the existing values.

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

• (matches 0 or more characters)

• ? (matches exactly 1 character)

Returns:

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

withConditions

public CreateRuleRequest withConditions(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 &)

• * (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 &)

• (matches 0 or more characters)

• ? (matches exactly 1 character)

Returns:

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

setPriority

public void setPriority(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.

getPriority

public Integer getPriority()

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.

withPriority

public CreateRuleRequest withPriority(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.

getActions

public List<Action> getActions()

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 or TLS 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:

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

setActions

public void setActions(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. The protocol of the target group must be TCP or TLS 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.

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

withActions

public CreateRuleRequest withActions(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 or TLS 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.

NOTE: This method appends the values to the existing list (if any). Use setActions(java.util.Collection) or withActions(java.util.Collection) if you want to override the existing values.

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. The protocol of the target group must be TCP or TLS 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.

withActions

public CreateRuleRequest withActions(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. The protocol of the target group must be TCP or TLS 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.

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

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateRuleRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()