com.amazonaws.services.elasticloadbalancingv2.model

Class ModifyRuleRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticloadbalancingv2.model.ModifyRuleRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ModifyRuleRequest
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
ModifyRuleRequest()

Method Summary

Modifier and Type	Method and Description
ModifyRuleRequest	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	getRuleArn() The Amazon Resource Name (ARN) of the rule.
int	hashCode()
void	setActions(Collection<Action> actions) The actions.
void	setConditions(Collection<RuleCondition> conditions) The conditions.
void	setRuleArn(String ruleArn) The Amazon Resource Name (ARN) of the rule.
String	toString() Returns a string representation of this object.
ModifyRuleRequest	withActions(Action... actions) The actions.
ModifyRuleRequest	withActions(Collection<Action> actions) The actions.
ModifyRuleRequest	withConditions(Collection<RuleCondition> conditions) The conditions.
ModifyRuleRequest	withConditions(RuleCondition... conditions) The conditions.
ModifyRuleRequest	withRuleArn(String ruleArn) The Amazon Resource Name (ARN) of the rule.

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

ModifyRuleRequest

public ModifyRuleRequest()

Method Detail

setRuleArn

public void setRuleArn(String ruleArn)

The Amazon Resource Name (ARN) of the rule.

Parameters:

ruleArn - The Amazon Resource Name (ARN) of the rule.

getRuleArn

public String getRuleArn()

The Amazon Resource Name (ARN) of the rule.

Returns:

The Amazon Resource Name (ARN) of the rule.

withRuleArn

public ModifyRuleRequest withRuleArn(String ruleArn)

The Amazon Resource Name (ARN) of the rule.

Parameters:

ruleArn - The Amazon Resource Name (ARN) of the rule.

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

getActions

public List<Action> getActions()

The actions.

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.

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.

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.

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 ModifyRuleRequest withActions(Action... actions)

The actions.

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.

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 ModifyRuleRequest withActions(Collection<Action> actions)

The actions.

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.

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 ModifyRuleRequest 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()