AccessLogField (software.amazon.awscdk:aws-cdk-lib 2.0.0-rc.10 API)

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

All Implemented Interfaces:: software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:46.005Z")
 @Stability(value=Experimental)
public class AccessLogField
extends software.amazon.jsii.JsiiObject

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

Nested Class Summary
- Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
  software.amazon.jsii.JsiiObject.InitializationMode

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

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Constructor Detail
  - AccessLogField
```
protected AccessLogField(software.amazon.jsii.JsiiObjectRef objRef)
```
  - AccessLogField
```
protected AccessLogField(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - AccessLogField
```
@Stability(value=Experimental)
public AccessLogField()
```
- Method Detail
  - contextAccountId
```
@Stability(value=Experimental)
 @NotNull
public static String contextAccountId()
```
    (experimental) The API owner's AWS account ID.
  - contextApiId
```
@Stability(value=Experimental)
 @NotNull
public static String contextApiId()
```
    (experimental) The identifier API Gateway assigns to your API.
  - contextAuthorizer
```
@Stability(value=Experimental)
 @NotNull
public static String contextAuthorizer(@NotNull
                                                                                String property)
```
    (experimental) 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
```
@Stability(value=Experimental)
 @NotNull
public static String contextAuthorizerClaims(@NotNull
                                                                                      String property)
```
    (experimental) 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
```
@Stability(value=Experimental)
 @NotNull
public static String contextAuthorizerIntegrationLatency()
```
    (experimental) The authorizer latency in ms.
  - contextAuthorizerPrincipalId
```
@Stability(value=Experimental)
 @NotNull
public static String contextAuthorizerPrincipalId()
```
    (experimental) 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
```
@Stability(value=Experimental)
 @NotNull
public static String contextAwsEndpointRequestId()
```
    (experimental) The AWS endpoint's request ID.
  - contextDomainName
```
@Stability(value=Experimental)
 @NotNull
public static String contextDomainName()
```
    (experimental) The full domain name used to invoke the API.
    This should be the same as the incoming Host header.
  - contextDomainPrefix
```
@Stability(value=Experimental)
 @NotNull
public static String contextDomainPrefix()
```
    (experimental) The first label of the `$context.domainName`. This is often used as a caller/customer identifier.
  - contextErrorMessage
```
@Stability(value=Experimental)
 @NotNull
public static String contextErrorMessage()
```
    (experimental) A string containing an API Gateway error message.
  - contextErrorMessageString
```
@Stability(value=Experimental)
 @NotNull
public static String contextErrorMessageString()
```
    (experimental) The quoted value of $context.error.message, namely "$context.error.message".
  - contextErrorResponseType
```
@Stability(value=Experimental)
 @NotNull
public static String contextErrorResponseType()
```
    (experimental) 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
```
@Stability(value=Experimental)
 @NotNull
public static String contextErrorValidationErrorString()
```
    (experimental) A string containing a detailed validation error message.
  - contextExtendedRequestId
```
@Stability(value=Experimental)
 @NotNull
public static String contextExtendedRequestId()
```
    (experimental) The extended ID that API Gateway assigns to the API request, which contains more useful information for debugging/troubleshooting.
  - contextHttpMethod
```
@Stability(value=Experimental)
 @NotNull
public static String contextHttpMethod()
```
    (experimental) The HTTP method used.
    Valid values include: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
  - contextIdentityAccountId
```
@Stability(value=Experimental)
 @NotNull
public static String contextIdentityAccountId()
```
    (experimental) The AWS account ID associated with the request.
  - contextIdentityApiKey
```
@Stability(value=Experimental)
 @NotNull
public static String contextIdentityApiKey()
```
    (experimental) 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
```
@Stability(value=Experimental)
 @NotNull
public static String contextIdentityApiKeyId()
```
    (experimental) The API key ID associated with an API request that requires an API key.
  - contextIdentityCaller
```
@Stability(value=Experimental)
 @NotNull
public static String contextIdentityCaller()
```
    (experimental) The principal identifier of the caller making the request.
  - contextIdentityCognitoAuthenticationProvider
```
@Stability(value=Experimental)
 @NotNull
public static String contextIdentityCognitoAuthenticationProvider()
```
    (experimental) 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
```
@Stability(value=Experimental)
 @NotNull
public static String contextIdentityCognitoAuthenticationType()
```
    (experimental) The Amazon Cognito authentication type of the caller making the request.
    Available only if the request was signed with Amazon Cognito credentials.
  - contextIdentityCognitoIdentityId
```
@Stability(value=Experimental)
 @NotNull
public static String contextIdentityCognitoIdentityId()
```
    (experimental) The Amazon Cognito identity ID of the caller making the request.
    Available only if the request was signed with Amazon Cognito credentials.
  - contextIdentityCognitoIdentityPoolId
```
@Stability(value=Experimental)
 @NotNull
public static String contextIdentityCognitoIdentityPoolId()
```
    (experimental) The Amazon Cognito identity pool ID of the caller making the request.
    Available only if the request was signed with Amazon Cognito credentials.
  - contextIdentityPrincipalOrgId
```
@Stability(value=Experimental)
 @NotNull
public static String contextIdentityPrincipalOrgId()
```
    (experimental) The AWS organization ID.
  - contextIdentitySourceIp
```
@Stability(value=Experimental)
 @NotNull
public static String contextIdentitySourceIp()
```
    (experimental) 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
```
@Stability(value=Experimental)
 @NotNull
public static String contextIdentityUser()
```
    (experimental) 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
```
@Stability(value=Experimental)
 @NotNull
public static String contextIdentityUserAgent()
```
    (experimental) The User-Agent header of the API caller.
  - contextIdentityUserArn
```
@Stability(value=Experimental)
 @NotNull
public static String contextIdentityUserArn()
```
    (experimental) 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
```
@Stability(value=Experimental)
 @NotNull
public static String contextIntegrationLatency()
```
    (experimental) The integration latency in ms.
  - contextIntegrationStatus
```
@Stability(value=Experimental)
 @NotNull
public static String contextIntegrationStatus()
```
    (experimental) For Lambda proxy integration, this parameter represents the status code returned from AWS Lambda, not from the backend Lambda function.
  - contextPath
```
@Stability(value=Experimental)
 @NotNull
public static String contextPath()
```
    (experimental) 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
```
@Stability(value=Experimental)
 @NotNull
public static String contextProtocol()
```
    (experimental) The request protocol, for example, HTTP/1.1.
  - contextRequestId
```
@Stability(value=Experimental)
 @NotNull
public static String contextRequestId()
```
    (experimental) The ID that API Gateway assigns to the API request.
  - contextRequestOverrideHeader
```
@Stability(value=Experimental)
 @NotNull
public static String contextRequestOverrideHeader(@NotNull
                                                                                           String headerName)
```
    (experimental) 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
```
@Stability(value=Experimental)
 @NotNull
public static String contextRequestOverridePath(@NotNull
                                                                                         String pathName)
```
    (experimental) 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
```
@Stability(value=Experimental)
 @NotNull
public static String contextRequestOverrideQuerystring(@NotNull
                                                                                                String querystringName)
```
    (experimental) 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
```
@Stability(value=Experimental)
 @NotNull
public static String contextRequestTime()
```
    (experimental) The CLF-formatted request time (dd/MMM/yyyy:HH:mm:ss +-hhmm).
  - contextRequestTimeEpoch
```
@Stability(value=Experimental)
 @NotNull
public static String contextRequestTimeEpoch()
```
    (experimental) The Epoch-formatted request time.
  - contextResourceId
```
@Stability(value=Experimental)
 @NotNull
public static String contextResourceId()
```
    (experimental) The identifier that API Gateway assigns to your resource.
  - contextResourcePath
```
@Stability(value=Experimental)
 @NotNull
public static String contextResourcePath()
```
    (experimental) 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
```
@Stability(value=Experimental)
 @NotNull
public static String contextResponseLatency()
```
    (experimental) The response latency in ms.
  - contextResponseLength
```
@Stability(value=Experimental)
 @NotNull
public static String contextResponseLength()
```
    (experimental) The response payload length.
  - contextResponseOverrideHeader
```
@Stability(value=Experimental)
 @NotNull
public static String contextResponseOverrideHeader(@NotNull
                                                                                            String headerName)
```
    (experimental) 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
```
@Stability(value=Experimental)
 @NotNull
public static String contextResponseOverrideStatus()
```
    (experimental) 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
```
@Stability(value=Experimental)
 @NotNull
public static String contextStage()
```
    (experimental) The deployment stage of the API request (for example, `Beta` or `Prod`).
  - contextStatus
```
@Stability(value=Experimental)
 @NotNull
public static String contextStatus()
```
    (experimental) The method response status.
  - contextWafResponseCode
```
@Stability(value=Experimental)
 @NotNull
public static String contextWafResponseCode()
```
    (experimental) 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
```
@Stability(value=Experimental)
 @NotNull
public static String contextWebaclArn()
```
    (experimental) 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
```
@Stability(value=Experimental)
 @NotNull
public static String contextXrayTraceId()
```
    (experimental) The trace ID for the X-Ray trace.
    
    See Also:
    
    https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-enabling-xray.html

Class AccessLogField

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

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