AccessLogField

class aws_cdk.aws_apigateway.AccessLogField

Bases: object

$context variables that can be used to customize access log pattern.

ExampleMetadata:: infused

Example:

apigateway.AccessLogFormat.custom(JSON.stringify({
    "request_id": apigateway.AccessLogField.context_request_id(),
    "source_ip": apigateway.AccessLogField.context_identity_source_ip(),
    "method": apigateway.AccessLogField.context_http_method(),
    "user_context": {
        "sub": apigateway.AccessLogField.context_authorizer_claims("sub"),
        "email": apigateway.AccessLogField.context_authorizer_claims("email")
    }
}))

Static Methods

classmethod context_account_id()

(deprecated) The API callers AWS account ID.

Deprecated:: Use contextCallerAccountId or contextOwnerAccountId instead
Stability:: deprecated
Return type:: str

classmethod context_api_id()

The identifier API Gateway assigns to your API.

Return type:: str

classmethod context_authenticate_error()

The error message returned from an authentication attempt.

Return type:: str

classmethod context_authenticate_latency()

The authentication latency in ms.

Return type:: str

classmethod context_authenticate_status()

The status code returned from an authentication attempt.

Return type:: str

classmethod context_authorize_error()

The authorization error message.

Return type:: str

classmethod context_authorize_latency()

The authorization latency in ms.

Return type:: str

classmethod context_authorize_status()

The status code returned from an authorization attempt.

Return type:: str

classmethod context_authorizer(property)

The stringified value of the specified key-value pair of the context map returned from an API Gateway Lambda authorizer function.

Parameters:: property (str) – key of the context map.
See:: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html
Return type:: str

classmethod context_authorizer_claims(property)

A property of the claims returned from the Amazon Cognito user pool after the method caller is successfully authenticated.

Parameters:: property (str) – A property key of the claims.
See:: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html
Return type:: str

classmethod context_authorizer_error()

The error message returned from an authorizer.

Return type:: str

classmethod context_authorizer_integration_latency()

The authorizer latency in ms.

Return type:: str

classmethod context_authorizer_integration_status()

The status code returned from a Lambda authorizer.

Return type:: str

classmethod context_authorizer_latency()

The authorizer latency in ms.

Return type:: str

classmethod context_authorizer_principal_id()

The principal user identification associated with the token sent by the client and returned from an API Gateway Lambda authorizer (formerly known as a custom authorizer).

See:: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html
Return type:: str

classmethod context_authorizer_request_id()

The AWS endpoint’s request ID.

Return type:: str

classmethod context_authorizer_status()

The status code returned from an authorizer.

Return type:: str

classmethod context_aws_endpoint_request_id()

The AWS endpoint’s request ID.

Return type:: str

classmethod context_caller_account_id()

The API callers AWS account ID.

Return type:: str

classmethod context_custom_domain_base_path_matched()

The path for an API mapping that an incoming request matched.

Applicable when a client uses a custom domain name to access an API. For example if a client sends a request to https://api.example.com/v1/orders/1234, and the request matches the API mapping with the path v1/orders, the value is v1/orders.

See:: https://docs.aws.amazon.com/en_jp/apigateway/latest/developerguide/rest-api-mappings.html
Return type:: str

classmethod context_domain_name()

The full domain name used to invoke the API.

This should be the same as the incoming Host header.

Return type:: str

classmethod context_domain_prefix()

The first label of the $context.domainName. This is often used as a caller/customer identifier.

Return type:: str

classmethod context_error_message()

A string containing an API Gateway error message.

Return type:: str

classmethod context_error_message_string()

The quoted value of $context.error.message, namely “$context.error.message”.

Return type:: str

classmethod context_error_response_type()

A type of GatewayResponse.

This variable can only be used for simple variable substitution in a GatewayResponse body-mapping template, which is not processed by the Velocity Template Language engine, and in access logging.

See:: https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html
Return type:: str

classmethod context_error_validation_error_string()

A string containing a detailed validation error message.

Return type:: str

classmethod context_extended_request_id()

The extended ID that API Gateway assigns to the API request, which contains more useful information for debugging/troubleshooting.

Return type:: str

classmethod context_http_method()

The HTTP method used.

Valid values include: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

Return type:: str

classmethod context_identity_account_id()

The AWS account ID associated with the request.

Return type:: str

classmethod context_identity_api_key()

For API methods that require an API key, this variable is the API key associated with the method request.

For methods that don’t require an API key, this variable is

See:: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html
Return type:: str

classmethod context_identity_api_key_id()

The API key ID associated with an API request that requires an API key.

Return type:: str

classmethod context_identity_caller()

The principal identifier of the caller making the request.

Return type:: str

classmethod context_identity_client_cert_issuner_dn()

The distinguished name of the issuer of the certificate that a client presents.