Action (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.elasticloadbalancingv2.model.Action

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Action
extends Object
implements Serializable, Cloneable
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Action()

Constructors
Constructor and Description
`Action()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Action`	`clone()`
`boolean`	`equals(Object obj)`
`AuthenticateCognitoActionConfig`	`getAuthenticateCognitoConfig()` [HTTPS listeners] Information for using Amazon Cognito to authenticate users.
`AuthenticateOidcActionConfig`	`getAuthenticateOidcConfig()` [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC).
`FixedResponseActionConfig`	`getFixedResponseConfig()` [Application Load Balancer] Information for creating an action that returns a custom HTTP response.
`ForwardActionConfig`	`getForwardConfig()` Information for creating an action that distributes requests among one or more target groups.
`Integer`	`getOrder()` The order for the action.
`RedirectActionConfig`	`getRedirectConfig()` [Application Load Balancer] Information for creating a redirect action.
`String`	`getTargetGroupArn()` The Amazon Resource Name (ARN) of the target group.
`String`	`getType()` The type of action.
`int`	`hashCode()`
`void`	`setAuthenticateCognitoConfig(AuthenticateCognitoActionConfig authenticateCognitoConfig)` [HTTPS listeners] Information for using Amazon Cognito to authenticate users.
`void`	`setAuthenticateOidcConfig(AuthenticateOidcActionConfig authenticateOidcConfig)` [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC).
`void`	`setFixedResponseConfig(FixedResponseActionConfig fixedResponseConfig)` [Application Load Balancer] Information for creating an action that returns a custom HTTP response.
`void`	`setForwardConfig(ForwardActionConfig forwardConfig)` Information for creating an action that distributes requests among one or more target groups.
`void`	`setOrder(Integer order)` The order for the action.
`void`	`setRedirectConfig(RedirectActionConfig redirectConfig)` [Application Load Balancer] Information for creating a redirect action.
`void`	`setTargetGroupArn(String targetGroupArn)` The Amazon Resource Name (ARN) of the target group.
`void`	`setType(ActionTypeEnum type)` The type of action.
`void`	`setType(String type)` The type of action.
`String`	`toString()` Returns a string representation of this object.
`Action`	`withAuthenticateCognitoConfig(AuthenticateCognitoActionConfig authenticateCognitoConfig)` [HTTPS listeners] Information for using Amazon Cognito to authenticate users.
`Action`	`withAuthenticateOidcConfig(AuthenticateOidcActionConfig authenticateOidcConfig)` [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC).
`Action`	`withFixedResponseConfig(FixedResponseActionConfig fixedResponseConfig)` [Application Load Balancer] Information for creating an action that returns a custom HTTP response.
`Action`	`withForwardConfig(ForwardActionConfig forwardConfig)` Information for creating an action that distributes requests among one or more target groups.
`Action`	`withOrder(Integer order)` The order for the action.
`Action`	`withRedirectConfig(RedirectActionConfig redirectConfig)` [Application Load Balancer] Information for creating a redirect action.
`Action`	`withTargetGroupArn(String targetGroupArn)` The Amazon Resource Name (ARN) of the target group.
`Action`	`withType(ActionTypeEnum type)` The type of action.
`Action`	`withType(String type)` The type of action.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Action
```
public Action()
```
- Method Detail
  - setType
```
public void setType(String type)
```
    The type of action.
    
    Parameters:
    
    type - The type of action.
    
    See Also:
    
    ActionTypeEnum
  - getType
```
public String getType()
```
    The type of action.
    
    Returns:
    
    The type of action.
    
    See Also:
    
    ActionTypeEnum
  - withType
```
public Action withType(String type)
```
    The type of action.
    
    Parameters:
    
    type - The type of action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ActionTypeEnum
  - setType
```
public void setType(ActionTypeEnum type)
```
    The type of action.
    
    Parameters:
    
    type - The type of action.
    
    See Also:
    
    ActionTypeEnum
  - withType
```
public Action withType(ActionTypeEnum type)
```
    The type of action.
    
    Parameters:
    
    type - The type of action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ActionTypeEnum
  - setTargetGroupArn
```
public void setTargetGroupArn(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.
    
    Parameters:
    
    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.
  - getTargetGroupArn
```
public String getTargetGroupArn()
```
    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.
  - withTargetGroupArn
```
public Action withTargetGroupArn(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthenticateOidcConfig
```
public void setAuthenticateOidcConfig(AuthenticateOidcActionConfig authenticateOidcConfig)
```
    [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.
    
    Parameters:
    
    authenticateOidcConfig - [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.
  - getAuthenticateOidcConfig
```
public AuthenticateOidcActionConfig getAuthenticateOidcConfig()
```
    [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.
  - withAuthenticateOidcConfig
```
public Action withAuthenticateOidcConfig(AuthenticateOidcActionConfig authenticateOidcConfig)
```
    [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.
    
    Parameters:
    
    authenticateOidcConfig - [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthenticateCognitoConfig
```
public void setAuthenticateCognitoConfig(AuthenticateCognitoActionConfig authenticateCognitoConfig)
```
    [HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.
    
    Parameters:
    
    authenticateCognitoConfig - [HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.
  - getAuthenticateCognitoConfig
```
public AuthenticateCognitoActionConfig getAuthenticateCognitoConfig()
```
    [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.
  - withAuthenticateCognitoConfig
```
public Action withAuthenticateCognitoConfig(AuthenticateCognitoActionConfig authenticateCognitoConfig)
```
    [HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.
    
    Parameters:
    
    authenticateCognitoConfig - [HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOrder
```
public void setOrder(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.
    
    Parameters:
    
    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.
  - getOrder
```
public Integer getOrder()
```
    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.
  - withOrder
```
public Action withOrder(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRedirectConfig
```
public void setRedirectConfig(RedirectActionConfig redirectConfig)
```
    [Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect.
    
    Parameters:
    
    redirectConfig - [Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect.
  - getRedirectConfig
```
public RedirectActionConfig getRedirectConfig()
```
    [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.
  - withRedirectConfig
```
public Action withRedirectConfig(RedirectActionConfig redirectConfig)
```
    [Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect.
    
    Parameters:
    
    redirectConfig - [Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFixedResponseConfig
```
public void setFixedResponseConfig(FixedResponseActionConfig fixedResponseConfig)
```
    [Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response.
    
    Parameters:
    
    fixedResponseConfig - [Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response.
  - getFixedResponseConfig
```
public FixedResponseActionConfig getFixedResponseConfig()
```
    [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.
  - withFixedResponseConfig
```
public Action withFixedResponseConfig(FixedResponseActionConfig fixedResponseConfig)
```
    [Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response.
    
    Parameters:
    
    fixedResponseConfig - [Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setForwardConfig
```
public void setForwardConfig(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.
    
    Parameters:
    
    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.
  - getForwardConfig
```
public ForwardActionConfig getForwardConfig()
```
    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.
  - withForwardConfig
```
public Action withForwardConfig(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.
    
    Parameters:
    
    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:
    
    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 Action clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class Action

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Action

Method Detail

setType

getType

withType

setType

withType

setTargetGroupArn

getTargetGroupArn

withTargetGroupArn

setAuthenticateOidcConfig

getAuthenticateOidcConfig

withAuthenticateOidcConfig

setAuthenticateCognitoConfig

getAuthenticateCognitoConfig

withAuthenticateCognitoConfig

setOrder

getOrder

withOrder

setRedirectConfig

getRedirectConfig

withRedirectConfig

setFixedResponseConfig

getFixedResponseConfig

withFixedResponseConfig

setForwardConfig

getForwardConfig

withForwardConfig

toString

equals

hashCode

clone