Module `aws_lambda_powertools.utilities.data_classes.alb_event`

Expand source code

from typing import Dict, List, Optional

from aws_lambda_powertools.utilities.data_classes.common import BaseProxyEvent, DictWrapper


class ALBEventRequestContext(DictWrapper):
    @property
    def elb_target_group_arn(self) -> str:
        """Target group arn for your Lambda function"""
        return self["requestContext"]["elb"]["targetGroupArn"]


class ALBEvent(BaseProxyEvent):
    """Application load balancer event

    Documentation:
    --------------
    - https://docs.aws.amazon.com/lambda/latest/dg/services-alb.html
    - https://docs.aws.amazon.com/elasticloadbalancing/latest/application/lambda-functions.html
    """

    @property
    def request_context(self) -> ALBEventRequestContext:
        return ALBEventRequestContext(self._data)

    @property
    def multi_value_query_string_parameters(self) -> Optional[Dict[str, List[str]]]:
        return self.get("multiValueQueryStringParameters")

    @property
    def multi_value_headers(self) -> Optional[Dict[str, List[str]]]:
        return self.get("multiValueHeaders")

Classes

class ALBEvent (data: Dict[str, Any])

Application load balancer event

Documentation:

Expand source code

class ALBEvent(BaseProxyEvent):
    """Application load balancer event

    Documentation:
    --------------
    - https://docs.aws.amazon.com/lambda/latest/dg/services-alb.html
    - https://docs.aws.amazon.com/elasticloadbalancing/latest/application/lambda-functions.html
    """

    @property
    def request_context(self) -> ALBEventRequestContext:
        return ALBEventRequestContext(self._data)

    @property
    def multi_value_query_string_parameters(self) -> Optional[Dict[str, List[str]]]:
        return self.get("multiValueQueryStringParameters")

    @property
    def multi_value_headers(self) -> Optional[Dict[str, List[str]]]:
        return self.get("multiValueHeaders")

Ancestors

Instance variables

var multi_value_headers : Optional[Dict[str, List[str]]]

Expand source code

@property
def multi_value_headers(self) -> Optional[Dict[str, List[str]]]:
    return self.get("multiValueHeaders")

var multi_value_query_string_parameters : Optional[Dict[str, List[str]]]

Expand source code

@property
def multi_value_query_string_parameters(self) -> Optional[Dict[str, List[str]]]:
    return self.get("multiValueQueryStringParameters")

var request_context : ALBEventRequestContext

Expand source code

@property
def request_context(self) -> ALBEventRequestContext:
    return ALBEventRequestContext(self._data)

Inherited members

BaseProxyEvent:
- body
- decoded_body
- get_header_value
- get_query_string_value
- http_method
- json_body
- raw_event

class ALBEventRequestContext (data: Dict[str, Any])

Provides a single read only access to a wrapper dict

Expand source code

class ALBEventRequestContext(DictWrapper):
    @property
    def elb_target_group_arn(self) -> str:
        """Target group arn for your Lambda function"""
        return self["requestContext"]["elb"]["targetGroupArn"]

Ancestors

DictWrapper

Instance variables

var elb_target_group_arn : str

Target group arn for your Lambda function

Expand source code

@property
def elb_target_group_arn(self) -> str:
    """Target group arn for your Lambda function"""
    return self["requestContext"]["elb"]["targetGroupArn"]

Inherited members

DictWrapper:
- raw_event