AccessLogField

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.apigateway.AccessLogField

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:57.944Z")
public class AccessLogField
extends software.amazon.jsii.JsiiObject

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

Example:

 AccessLogFormat.custom(JSON.stringify(Map.of(
         "requestId", AccessLogField.contextRequestId(),
         "sourceIp", AccessLogField.contextIdentitySourceIp(),
         "method", AccessLogField.contextHttpMethod(),
         "userContext", Map.of(
                 "sub", AccessLogField.contextAuthorizerClaims("sub"),
                 "email", AccessLogField.contextAuthorizerClaims("email")))));

Constructor Summary

Constructors
Modifier	Constructor and Description
	`AccessLogField()`
`protected`	`AccessLogField(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`AccessLogField(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`contextAccountId()` The API owner's AWS account ID.
`static java.lang.String`	`contextApiId()` The identifier API Gateway assigns to your API.
`static java.lang.String`	`contextAuthorizer(java.lang.String property)` The stringified value of the specified key-value pair of the `context` map returned from an API Gateway Lambda authorizer function.
`static java.lang.String`	`contextAuthorizerClaims(java.lang.String property)` A property of the claims returned from the Amazon Cognito user pool after the method caller is successfully authenticated.
`static java.lang.String`	`contextAuthorizerIntegrationLatency()` The authorizer latency in ms.
`static java.lang.String`	`contextAuthorizerPrincipalId()` 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).
`static java.lang.String`	`contextAwsEndpointRequestId()` The AWS endpoint's request ID.
`static java.lang.String`	`contextDomainName()` The full domain name used to invoke the API.
`static java.lang.String`	`contextDomainPrefix()` The first label of the `$context.domainName`.
`static java.lang.String`	`contextErrorMessage()` A string containing an API Gateway error message.
`static java.lang.String`	`contextErrorMessageString()` The quoted value of $context.error.message, namely "$context.error.message".
`static java.lang.String`	`contextErrorResponseType()` A type of GatewayResponse.
`static java.lang.String`	`contextErrorValidationErrorString()` A string containing a detailed validation error message.
`static java.lang.String`	`contextExtendedRequestId()` The extended ID that API Gateway assigns to the API request, which contains more useful information for debugging/troubleshooting.
`static java.lang.String`	`contextHttpMethod()` The HTTP method used.
`static java.lang.String`	`contextIdentityAccountId()` The AWS account ID associated with the request.
`static java.lang.String`	`contextIdentityApiKey()` For API methods that require an API key, this variable is the API key associated with the method request.
`static java.lang.String`	`contextIdentityApiKeyId()` The API key ID associated with an API request that requires an API key.
`static java.lang.String`	`contextIdentityCaller()` The principal identifier of the caller making the request.
`static java.lang.String`	`contextIdentityCognitoAuthenticationProvider()` The Amazon Cognito authentication provider used by the caller making the request.
`static java.lang.String`	`contextIdentityCognitoAuthenticationType()` The Amazon Cognito authentication type of the caller making the request.
`static java.lang.String`	`contextIdentityCognitoIdentityId()` The Amazon Cognito identity ID of the caller making the request.
`static java.lang.String`	`contextIdentityCognitoIdentityPoolId()` The Amazon Cognito identity pool ID of the caller making the request.
`static java.lang.String`	`contextIdentityPrincipalOrgId()` The AWS organization ID.
`static java.lang.String`	`contextIdentitySourceIp()` The source IP address of the TCP connection making the request to API Gateway.
`static java.lang.String`	`contextIdentityUser()` The principal identifier of the user making the request.
`static java.lang.String`	`contextIdentityUserAgent()` The User-Agent header of the API caller.
`static java.lang.String`	`contextIdentityUserArn()` The Amazon Resource Name (ARN) of the effective user identified after authentication.
`static java.lang.String`	`contextIntegrationLatency()` The integration latency in ms.
`static java.lang.String`	`contextIntegrationStatus()` For Lambda proxy integration, this parameter represents the status code returned from AWS Lambda, not from the backend Lambda function.
`static java.lang.String`	`contextPath()` The request path.
`static java.lang.String`	`contextProtocol()` The request protocol, for example, HTTP/1.1.
`static java.lang.String`	`contextRequestId()` The ID that API Gateway assigns to the API request.
`static java.lang.String`	`contextRequestOverrideHeader(java.lang.String headerName)` The request header override.
`static java.lang.String`	`contextRequestOverridePath(java.lang.String pathName)` The request path override.
`static java.lang.String`	`contextRequestOverrideQuerystring(java.lang.String querystringName)` The request query string override.
`static java.lang.String`	`contextRequestTime()` The CLF-formatted request time (dd/MMM/yyyy:HH:mm:ss +-hhmm).
`static java.lang.String`	`contextRequestTimeEpoch()` The Epoch-formatted request time.
`static java.lang.String`	`contextResourceId()` The identifier that API Gateway assigns to your resource.
`static java.lang.String`	`contextResourcePath()` The path to your resource.
`static java.lang.String`	`contextResponseLatency()` The response latency in ms.
`static java.lang.String`	`contextResponseLength()` The response payload length.
`static java.lang.String`	`contextResponseOverrideHeader(java.lang.String headerName)` The response header override.
`static java.lang.String`	`contextResponseOverrideStatus()` The response status code override.
`static java.lang.String`	`contextStage()` The deployment stage of the API request (for example, `Beta` or `Prod`).
`static java.lang.String`	`contextStatus()` The method response status.
`static java.lang.String`	`contextWafResponseCode()` The response received from AWS WAF: `WAF_ALLOW` or `WAF_BLOCK`.
`static java.lang.String`	`contextWebaclArn()` The complete ARN of the web ACL that is used to decide whether to allow or block the request.
`static java.lang.String`	`contextXrayTraceId()` The trace ID for the X-Ray trace.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AccessLogField
```
protected AccessLogField(software.amazon.jsii.JsiiObjectRef objRef)
```
  - AccessLogField
```
protected AccessLogField(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - AccessLogField
```
public AccessLogField()
```
- Method Detail
  - contextAccountId
```
public static java.lang.String contextAccountId()
```
    The API owner's AWS account ID.
  - contextApiId
```
public static java.lang.String contextApiId()
```
    The identifier API Gateway assigns to your API.
  - contextAuthorizer
```
public static java.lang.String contextAuthorizer(java.lang.String property)
```
    The stringified value of the specified key-value pair of the `context` map returned from an API Gateway Lambda authorizer function.
    
    Parameters:
    
    property - key of the context map. This parameter is required.
    
    See Also:
    
    https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html
  - contextAuthorizerClaims
```
public static java.lang.String contextAuthorizerClaims(java.lang.String property)
```
    A property of the claims returned from the Amazon Cognito user pool after the method caller is successfully authenticated.
    
    Parameters:
    
    property - A property key of the claims. This parameter is required.
    
    See Also:
    
    https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html
  - contextAuthorizerIntegrationLatency
```
public static java.lang.String contextAuthorizerIntegrationLatency()
```
    The authorizer latency in ms.
  - contextAuthorizerPrincipalId
```
public static java.lang.String contextAuthorizerPrincipalId()
```
    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 Also:
    
    https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html
  - contextAwsEndpointRequestId
```
public static java.lang.String contextAwsEndpointRequestId()
```
    The AWS endpoint's request ID.
  - contextDomainName
```
public static java.lang.String contextDomainName()
```
    The full domain name used to invoke the API.
    This should be the same as the incoming Host header.
  - contextDomainPrefix
```
public static java.lang.String contextDomainPrefix()
```
    The first label of the `$context.domainName`. This is often used as a caller/customer identifier.
  - contextErrorMessage
```
public static java.lang.String contextErrorMessage()
```
    A string containing an API Gateway error message.
  - contextErrorMessageString
```
public static java.lang.String contextErrorMessageString()
```
    The quoted value of $context.error.message, namely "$context.error.message".
  - contextErrorResponseType
```
public static java.lang.String contextErrorResponseType()
```
    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 Also:
    
    https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html
  - contextErrorValidationErrorString
```
public static java.lang.String contextErrorValidationErrorString()
```
    A string containing a detailed validation error message.
  - contextExtendedRequestId
```
public static java.lang.String contextExtendedRequestId()
```
    The extended ID that API Gateway assigns to the API request, which contains more useful information for debugging/troubleshooting.
  - contextHttpMethod
```
public static java.lang.String contextHttpMethod()
```
    The HTTP method used.
    Valid values include: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
  - contextIdentityAccountId
```
public static java.lang.String contextIdentityAccountId()
```
    The AWS account ID associated with the request.
  - contextIdentityApiKey
```
public static java.lang.String contextIdentityApiKey()
```
    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 Also:
    
    https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html
  - contextIdentityApiKeyId
```
public static java.lang.String contextIdentityApiKeyId()
```
    The API key ID associated with an API request that requires an API key.
  - contextIdentityCaller
```
public static java.lang.String contextIdentityCaller()
```
    The principal identifier of the caller making the request.
  - contextIdentityCognitoAuthenticationProvider
```
public static java.lang.String contextIdentityCognitoAuthenticationProvider()
```
    The Amazon Cognito authentication provider used by the caller making the request.
    Available only if the request was signed with Amazon Cognito credentials.
    
    See Also:
    
    https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html
  - contextIdentityCognitoAuthenticationType
```
public static java.lang.String contextIdentityCognitoAuthenticationType()
```
    The Amazon Cognito authentication type of the caller making the request.
    Available only if the request was signed with Amazon Cognito credentials.
  - contextIdentityCognitoIdentityId
```
public static java.lang.String contextIdentityCognitoIdentityId()
```
    The Amazon Cognito identity ID of the caller making the request.
    Available only if the request was signed with Amazon Cognito credentials.
  - contextIdentityCognitoIdentityPoolId
```
public static java.lang.String contextIdentityCognitoIdentityPoolId()
```
    The Amazon Cognito identity pool ID of the caller making the request.
    Available only if the request was signed with Amazon Cognito credentials.
  - contextIdentityPrincipalOrgId
```
public static java.lang.String contextIdentityPrincipalOrgId()
```
    The AWS organization ID.
  - contextIdentitySourceIp
```
public static java.lang.String contextIdentitySourceIp()
```
    The source IP address of the TCP connection making the request to API Gateway.
    Warning: You should not trust this value if there is any chance that the X-Forwarded-For header could be forged.
  - contextIdentityUser
```
public static java.lang.String contextIdentityUser()
```
    The principal identifier of the user making the request.
    Used in Lambda authorizers.
    
    See Also:
    
    https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-output.html
  - contextIdentityUserAgent
```
public static java.lang.String contextIdentityUserAgent()
```
    The User-Agent header of the API caller.
  - contextIdentityUserArn
```
public static java.lang.String contextIdentityUserArn()
```
    The Amazon Resource Name (ARN) of the effective user identified after authentication.
    
    See Also:
    
    https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html
  - contextIntegrationLatency
```
public static java.lang.String contextIntegrationLatency()
```
    The integration latency in ms.
  - contextIntegrationStatus
```
public static java.lang.String contextIntegrationStatus()
```
    For Lambda proxy integration, this parameter represents the status code returned from AWS Lambda, not from the backend Lambda function.
  - contextPath
```
public static java.lang.String contextPath()
```
    The request path.
    For example, for a non-proxy request URL of https://{rest-api-id.execute-api.{region}.amazonaws.com/{stage}/root/child, this value is /{stage}/root/child.
  - contextProtocol
```
public static java.lang.String contextProtocol()
```
    The request protocol, for example, HTTP/1.1.
  - contextRequestId
```
public static java.lang.String contextRequestId()
```
    The ID that API Gateway assigns to the API request.
  - contextRequestOverrideHeader
```
public static java.lang.String contextRequestOverrideHeader(java.lang.String headerName)
```
    The request header override.
    If this parameter is defined, it contains the headers to be used instead of the HTTP Headers that are defined in the Integration Request pane.
    
    Parameters:
    
    headerName - This parameter is required.
    
    See Also:
    
    https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html
  - contextRequestOverridePath
```
public static java.lang.String contextRequestOverridePath(java.lang.String pathName)
```
    The request path override.
    If this parameter is defined, it contains the request path to be used instead of the URL Path Parameters that are defined in the Integration Request pane.
    
    Parameters:
    
    pathName - This parameter is required.
    
    See Also:
    
    https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html
  - contextRequestOverrideQuerystring
```
public static java.lang.String contextRequestOverrideQuerystring(java.lang.String querystringName)
```
    The request query string override.
    If this parameter is defined, it contains the request query strings to be used instead of the URL Query String Parameters that are defined in the Integration Request pane.
    
    Parameters:
    
    querystringName - This parameter is required.
  - contextRequestTime
```
public static java.lang.String contextRequestTime()
```
    The CLF-formatted request time (dd/MMM/yyyy:HH:mm:ss +-hhmm).
  - contextRequestTimeEpoch
```
public static java.lang.String contextRequestTimeEpoch()
```
    The Epoch-formatted request time.
  - contextResourceId
```
public static java.lang.String contextResourceId()
```
    The identifier that API Gateway assigns to your resource.
  - contextResourcePath
```
public static java.lang.String contextResourcePath()
```
    The path to your resource.
    For example, for the non-proxy request URI of https://{rest-api-id.execute-api.{region}.amazonaws.com/{stage}/root/child, The $context.resourcePath value is /root/child.
    
    See Also:
    
    https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-api-step-by-step.html
  - contextResponseLatency
```
public static java.lang.String contextResponseLatency()
```
    The response latency in ms.
  - contextResponseLength
```
public static java.lang.String contextResponseLength()
```
    The response payload length.
  - contextResponseOverrideHeader
```
public static java.lang.String contextResponseOverrideHeader(java.lang.String headerName)
```
    The response header override.
    If this parameter is defined, it contains the header to be returned instead of the Response header that is defined as the Default mapping in the Integration Response pane.
    
    Parameters:
    
    headerName - This parameter is required.
    
    See Also:
    
    https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html
  - contextResponseOverrideStatus
```
public static java.lang.String contextResponseOverrideStatus()
```
    The response status code override.
    If this parameter is defined, it contains the status code to be returned instead of the Method response status that is defined as the Default mapping in the Integration Response pane.
    
    See Also:
    
    https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html
  - contextStage
```
public static java.lang.String contextStage()
```
    The deployment stage of the API request (for example, `Beta` or `Prod`).
  - contextStatus
```
public static java.lang.String contextStatus()
```
    The method response status.
  - contextWafResponseCode
```
public static java.lang.String contextWafResponseCode()
```
    The response received from AWS WAF: `WAF_ALLOW` or `WAF_BLOCK`.
    Will not be set if the stage is not associated with a web ACL.
    
    See Also:
    
    https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-control-access-aws-waf.html
  - contextWebaclArn
```
public static java.lang.String contextWebaclArn()
```
    The complete ARN of the web ACL that is used to decide whether to allow or block the request.
    Will not be set if the stage is not associated with a web ACL.
    
    See Also:
    
    https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-control-access-aws-waf.html
  - contextXrayTraceId
```
public static java.lang.String contextXrayTraceId()
```
    The trace ID for the X-Ray trace.
    
    See Also:
    
    https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-enabling-xray.html

Class AccessLogField

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AccessLogField

AccessLogField

AccessLogField

Method Detail

contextAccountId

contextApiId

contextAuthorizer

contextAuthorizerClaims

contextAuthorizerIntegrationLatency

contextAuthorizerPrincipalId

contextAwsEndpointRequestId

contextDomainName

contextDomainPrefix

contextErrorMessage

contextErrorMessageString

contextErrorResponseType

contextErrorValidationErrorString

contextExtendedRequestId

contextHttpMethod

contextIdentityAccountId

contextIdentityApiKey

contextIdentityApiKeyId

contextIdentityCaller

contextIdentityCognitoAuthenticationProvider

contextIdentityCognitoAuthenticationType

contextIdentityCognitoIdentityId

contextIdentityCognitoIdentityPoolId

contextIdentityPrincipalOrgId

contextIdentitySourceIp

contextIdentityUser

contextIdentityUserAgent

contextIdentityUserArn

contextIntegrationLatency

contextIntegrationStatus

contextPath

contextProtocol

contextRequestId

contextRequestOverrideHeader

contextRequestOverridePath

contextRequestOverrideQuerystring

contextRequestTime

contextRequestTimeEpoch

contextResourceId

contextResourcePath

contextResponseLatency

contextResponseLength

contextResponseOverrideHeader

contextResponseOverrideStatus

contextStage

contextStatus

contextWafResponseCode

contextWebaclArn

contextXrayTraceId