ParameterMapping

class aws_cdk.aws_apigatewayv2.ParameterMapping

Bases: object

Represents a Parameter Mapping.

ExampleMetadata:: infused

Example:

from aws_cdk.aws_apigatewayv2_integrations import HttpAlbIntegration

# lb: elbv2.ApplicationLoadBalancer

listener = lb.add_listener("listener", port=80)
listener.add_targets("target",
    port=80
)

http_endpoint = apigwv2.HttpApi(self, "HttpProxyPrivateApi",
    default_integration=HttpAlbIntegration("DefaultIntegration", listener,
        parameter_mapping=apigwv2.ParameterMapping().append_header("header2", apigwv2.MappingValue.request_header("header1")).remove_header("header1")
    )
)

Methods

append_header(name, value)

Creates a mapping to append a header.

Parameters:

name (str)
value (MappingValue)

Return type:

ParameterMapping

append_query_string(name, value)

Creates a mapping to append a query string.

Parameters:

name (str)
value (MappingValue)

Return type:

ParameterMapping

custom(key, value)

Creates a custom mapping.

Parameters:

key (str)
value (str)

Return type:

ParameterMapping

overwrite_header(name, value)

Creates a mapping to overwrite a header.

Parameters:

name (str)
value (MappingValue)

Return type:

ParameterMapping

overwrite_path(value)

Creates a mapping to overwrite a path.

Parameters:: value (MappingValue)
Return type:: ParameterMapping

overwrite_query_string(name, value)

Creates a mapping to overwrite a querystring.

Parameters:

name (str)
value (MappingValue)

Return type:

ParameterMapping

remove_header(name)

Creates a mapping to remove a header.

Parameters:: name (str)
Return type:: ParameterMapping

remove_query_string(name)

Creates a mapping to remove a querystring.

Parameters:: name (str)
Return type:: ParameterMapping

Attributes

mappings: Represents all created parameter mappings.

Static Methods

classmethod from_object(obj)

Creates a mapping from an object.

Parameters:: obj (Mapping[str, MappingValue])
Return type:: ParameterMapping