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.
Contents
- Type
-
The type of action.
Type: String
Valid Values:
forward | authenticate-oidc | authenticate-cognito | redirect | fixed-responseRequired: Yes
- AuthenticateCognitoConfig
-
[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when
Typeisauthenticate-cognito.Type: AuthenticateCognitoActionConfig object
Required: No
- AuthenticateOidcConfig
-
[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when
Typeisauthenticate-oidc.Type: AuthenticateOidcActionConfig object
Required: No
- FixedResponseConfig
-
[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when
Typeisfixed-response.Type: FixedResponseActionConfig object
Required: No
- ForwardConfig
-
Information for creating an action that distributes requests among multiple target groups. Specify only when
Typeisforward.If you specify both
ForwardConfigandTargetGroupArn, you can specify only one target group usingForwardConfigand it must be the same target group specified inTargetGroupArn.Type: ForwardActionConfig object
Required: No
- 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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50000.
Required: No
- RedirectConfig
-
[Application Load Balancer] Information for creating a redirect action. Specify only when
Typeisredirect.Type: RedirectActionConfig object
Required: No
- TargetGroupArn
-
The Amazon Resource Name (ARN) of the target group. Specify only when
Typeisforwardand you want to route to a single target group. To route to multiple target groups, you must useForwardConfiginstead.Type: String
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: