Elastic Load Balancing
API Reference (API Version 2015-12-01)


Information about an action.



[HTTPS listener] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.

Type: AuthenticateCognitoActionConfig object

Required: No


[HTTPS listener] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.

Type: AuthenticateOidcActionConfig object

Required: No


[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response.

Type: FixedResponseActionConfig object

Required: No


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 final action to be performed must be a forward or a fixed-response action.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50000.

Required: No


[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect.

Type: RedirectActionConfig object

Required: No


The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward.

Type: String

Required: No


The type of action. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect.

Type: String

Valid Values: forward | authenticate-oidc | authenticate-cognito | redirect | fixed-response

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: