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.

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 listener] Information for using Amazon Cognito to authenticate users.
`AuthenticateOidcActionConfig`	`getAuthenticateOidcConfig()` [HTTPS listener] Information about an identity provider that is compliant with OpenID Connect (OIDC).
`Integer`	`getOrder()` The order for the 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 listener] Information for using Amazon Cognito to authenticate users.
`void`	`setAuthenticateOidcConfig(AuthenticateOidcActionConfig authenticateOidcConfig)` [HTTPS listener] Information about an identity provider that is compliant with OpenID Connect (OIDC).
`void`	`setOrder(Integer order)` The order for the 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; useful for testing and debugging.
`Action`	`withAuthenticateCognitoConfig(AuthenticateCognitoActionConfig authenticateCognitoConfig)` [HTTPS listener] Information for using Amazon Cognito to authenticate users.
`Action`	`withAuthenticateOidcConfig(AuthenticateOidcActionConfig authenticateOidcConfig)` [HTTPS listener] Information about an identity provider that is compliant with OpenID Connect (OIDC).
`Action`	`withOrder(Integer order)` The order for the 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. Each rule must include one forward action.
    
    Parameters:
    
    type - The type of action. Each rule must include one forward action.
    
    See Also:
    
    ActionTypeEnum
  - getType
```
public String getType()
```
    The type of action. Each rule must include one forward action.
    
    Returns:
    
    The type of action. Each rule must include one forward action.
    
    See Also:
    
    ActionTypeEnum
  - withType
```
public Action withType(String type)
```
    The type of action. Each rule must include one forward action.
    
    Parameters:
    
    type - The type of action. Each rule must include one forward 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. Each rule must include one forward action.
    
    Parameters:
    
    type - The type of action. Each rule must include one forward action.
    
    See Also:
    
    ActionTypeEnum
  - withType
```
public Action withType(ActionTypeEnum type)
```
    The type of action. Each rule must include one forward action.
    
    Parameters:
    
    type - The type of action. Each rule must include one forward 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.
    
    For a default rule, the protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.
    
    Parameters:
    
    targetGroupArn - The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward.
    
    For a default rule, the protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.
  - getTargetGroupArn
```
public String getTargetGroupArn()
```
    The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward.
    
    For a default rule, the protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward.
    
    For a default rule, the protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.
  - withTargetGroupArn
```
public Action withTargetGroupArn(String targetGroupArn)
```
    The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward.
    
    For a default rule, the protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.
    
    Parameters:
    
    targetGroupArn - The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward.
    
    For a default rule, the protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthenticateOidcConfig
```
public void setAuthenticateOidcConfig(AuthenticateOidcActionConfig authenticateOidcConfig)
```
    [HTTPS listener] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.
    
    Parameters:
    
    authenticateOidcConfig - [HTTPS listener] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.
  - getAuthenticateOidcConfig
```
public AuthenticateOidcActionConfig getAuthenticateOidcConfig()
```
    [HTTPS listener] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.
    
    Returns:
    
    [HTTPS listener] 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 listener] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.
    
    Parameters:
    
    authenticateOidcConfig - [HTTPS listener] 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 listener] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.
    
    Parameters:
    
    authenticateCognitoConfig - [HTTPS listener] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.
  - getAuthenticateCognitoConfig
```
public AuthenticateCognitoActionConfig getAuthenticateCognitoConfig()
```
    [HTTPS listener] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.
    
    Returns:
    
    [HTTPS listener] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.
  - withAuthenticateCognitoConfig
```
public Action withAuthenticateCognitoConfig(AuthenticateCognitoActionConfig authenticateCognitoConfig)
```
    [HTTPS listener] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.
    
    Parameters:
    
    authenticateCognitoConfig - [HTTPS listener] 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. The forward action must be performed last.
    
    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. The forward action must be performed last.
  - 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. The forward action must be performed last.
    
    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. The forward action must be performed last.
  - 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. The forward action must be performed last.
    
    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. The forward action must be performed last.
    
    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; useful for testing and debugging.
    
    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

toString

equals

hashCode

clone