@Generated(value="software.amazon.awssdk:codegen") public final class CreateRuleRequest extends ElasticLoadBalancingV2Request implements ToCopyableBuilder<CreateRuleRequest.Builder,CreateRuleRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateRuleRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
List<Action> |
actions()
The actions.
|
static CreateRuleRequest.Builder |
builder() |
List<RuleCondition> |
conditions()
The conditions.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfigurationcopypublic String listenerArn()
The Amazon Resource Name (ARN) of the listener.
public List<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)
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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)
public Integer priority()
The rule priority. A listener can't have multiple rules with the same priority.
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 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.
public CreateRuleRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<CreateRuleRequest.Builder,CreateRuleRequest>toBuilder in class ElasticLoadBalancingV2Requestpublic static CreateRuleRequest.Builder builder()
public static Class<? extends CreateRuleRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.