AWS::ElasticLoadBalancingV2::Listener Action - AWS CloudFormation
SyntaxProperties

AWS::ElasticLoadBalancingV2::Listener Action

Specifies an action for a listener rule.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

Properties

AuthenticateCognitoConfig

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

Required: No

Type: AuthenticateCognitoConfig

Update requires: No interruption

AuthenticateOidcConfig

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

Required: No

Type: AuthenticateOidcConfig

Update requires: No interruption

FixedResponseConfig

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

Required: No

Type: FixedResponseConfig

Update requires: No interruption

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.

Required: No

Type: ForwardConfig

Update requires: No interruption

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.

Required: No

Type: Integer

Minimum: 1

Maximum: 50000

Update requires: No interruption

RedirectConfig

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

Required: No

Type: RedirectConfig

Update requires: No interruption

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.

Required: No

Type: String

Update requires: No interruption

Type

The type of action.

Required: Yes

Type: String

Allowed values: forward | authenticate-oidc | authenticate-cognito | redirect | fixed-response

Update requires: No interruption