Action - Elastic Load Balancing
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


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.



The type of action.

Type: String

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

Required: Yes


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

Type: AuthenticateCognitoActionConfig object

Required: No


[HTTPS listeners] 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


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.

Type: ForwardActionConfig 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.

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 and you want to route to a single target group. To route to one or more target groups, use ForwardConfig instead.

Type: String

Required: No

See Also

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