Skip to content

Action

Source code in docs_src/capo_elastic_load_balancing_v2/types/action.py
class Action(TypedDict, closed=True):
    type: NotRequired[
        "capo_elastic_load_balancing_v2.types.action_type_enum.ActionTypeEnum"
    ]
    """<p>The type of action.</p>"""
    target_group_arn: NotRequired[
        "capo_elastic_load_balancing_v2.types.target_group_arn.TargetGroupArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the target group. Specify only when <code>Type</code> is <code>forward</code> and you want to route to a single target group. To route to multiple target groups, you must use <code>ForwardConfig</code> instead.</p>"""
    authenticate_oidc_config: NotRequired[
        "capo_elastic_load_balancing_v2.types.authenticate_oidc_action_config.AuthenticateOidcActionConfig"
    ]
    """<p>[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when <code>Type</code> is <code>authenticate-oidc</code>.</p>"""
    authenticate_cognito_config: NotRequired[
        "capo_elastic_load_balancing_v2.types.authenticate_cognito_action_config.AuthenticateCognitoActionConfig"
    ]
    """<p>[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when <code>Type</code> is <code>authenticate-cognito</code>.</p>"""
    order: NotRequired["capo_elastic_load_balancing_v2.types.action_order.ActionOrder"]
    """<p>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.</p>"""
    redirect_config: NotRequired[
        "capo_elastic_load_balancing_v2.types.redirect_action_config.RedirectActionConfig"
    ]
    """<p>[Application Load Balancer] Information for creating a redirect action. Specify only when <code>Type</code> is <code>redirect</code>.</p>"""
    fixed_response_config: NotRequired[
        "capo_elastic_load_balancing_v2.types.fixed_response_action_config.FixedResponseActionConfig"
    ]
    """<p>[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when <code>Type</code> is <code>fixed-response</code>.</p>"""
    forward_config: NotRequired[
        "capo_elastic_load_balancing_v2.types.forward_action_config.ForwardActionConfig"
    ]
    """<p>Information for creating an action that distributes requests among multiple target groups. Specify only when <code>Type</code> is <code>forward</code>.</p> <p>If you specify both <code>ForwardConfig</code> and <code>TargetGroupArn</code>, you can specify only one target group using <code>ForwardConfig</code> and it must be the same target group specified in <code>TargetGroupArn</code>.</p>"""
    jwt_validation_config: NotRequired[
        "capo_elastic_load_balancing_v2.types.jwt_validation_action_config.JwtValidationActionConfig"
    ]
    """<p>[HTTPS listeners] Information for validating JWT access tokens in client requests. Specify only when <code>Type</code> is <code>jwt-validation</code>.</p>"""

authenticate_cognito_config instance-attribute

authenticate_cognito_config: NotRequired[AuthenticateCognitoActionConfig]

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

authenticate_oidc_config instance-attribute

authenticate_oidc_config: NotRequired[AuthenticateOidcActionConfig]

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

fixed_response_config instance-attribute

fixed_response_config: NotRequired[FixedResponseActionConfig]

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

forward_config instance-attribute

forward_config: NotRequired[ForwardActionConfig]

Information for creating an action that distributes requests among multiple target groups. 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.

jwt_validation_config instance-attribute

jwt_validation_config: NotRequired[JwtValidationActionConfig]

[HTTPS listeners] Information for validating JWT access tokens in client requests. Specify only when Type is jwt-validation.

order instance-attribute

order: NotRequired[ActionOrder]

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.

redirect_config instance-attribute

redirect_config: NotRequired[RedirectActionConfig]

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

target_group_arn instance-attribute

target_group_arn: NotRequired[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 multiple target groups, you must use ForwardConfig instead.

type instance-attribute

type: NotRequired[ActionTypeEnum]

The type of action.