java.lang.Object
- software.amazon.awssdk.services.elasticloadbalancingv2.model.Action

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Action.Builder,Action>
```
@Generated("software.amazon.awssdk:codegen")
public final class Action
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Action.Builder,Action>
```
Information about an action.

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Action.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AuthenticateCognitoActionConfig`	`authenticateCognitoConfig()`	[HTTPS listeners] Information for using Amazon Cognito to authenticate users.
`AuthenticateOidcActionConfig`	`authenticateOidcConfig()`	[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC).
`static Action.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`FixedResponseActionConfig`	`fixedResponseConfig()`	[Application Load Balancer] Information for creating an action that returns a custom HTTP response.
`ForwardActionConfig`	`forwardConfig()`	Information for creating an action that distributes requests among one or more target groups.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`order()`	The order for the action.
`RedirectActionConfig`	`redirectConfig()`	[Application Load Balancer] Information for creating a redirect action.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Action.Builder>`	`serializableBuilderClass()`
`String`	`targetGroupArn()`	The Amazon Resource Name (ARN) of the target group.
`Action.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`ActionTypeEnum`	`type()`	The type of action.
`String`	`typeAsString()`	The type of action.

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
  - type
```
public final ActionTypeEnum type()
```
    The type of action.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ActionTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of action.
    
    See Also:
    
    ActionTypeEnum
  - typeAsString
```
public final String typeAsString()
```
    The type of action.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ActionTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of action.
    
    See Also:
    
    ActionTypeEnum
  - targetGroupArn
```
public final String targetGroupArn()
```
    The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.
  - authenticateOidcConfig
```
public final AuthenticateOidcActionConfig authenticateOidcConfig()
```
    [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.
    
    Returns:
    
    [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.
  - authenticateCognitoConfig
```
public final AuthenticateCognitoActionConfig authenticateCognitoConfig()
```
    [HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.
    
    Returns:
    
    [HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.
  - order
```
public final Integer order()
```
    The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.
    
    Returns:
    
    The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.
  - redirectConfig
```
public final RedirectActionConfig redirectConfig()
```
    [Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect.
    
    Returns:
    
    [Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect.
  - fixedResponseConfig
```
public final FixedResponseActionConfig fixedResponseConfig()
```
    [Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response.
    
    Returns:
    
    [Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response.
  - forwardConfig
```
public final ForwardActionConfig forwardConfig()
```
    Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn.
    
    Returns:
    
    Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when Type is forward. If you specify both ForwardConfig and TargetGroupArn, you can specify only one target group using ForwardConfig and it must be the same target group specified in TargetGroupArn.
  - toBuilder
```
public Action.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Action.Builder,Action>
  - builder
```
public static Action.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Action.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class Action

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

type

typeAsString

targetGroupArn

authenticateOidcConfig

authenticateCognitoConfig

order

redirectConfig

fixedResponseConfig

forwardConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField