Class: AWSCDK::APIGateway::AccessLogField

Inherits:
Jsii::Object
  • Object
show all
Defined in:
api_gateway/access_log_field.rb

Overview

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AccessLogField

Returns a new instance of AccessLogField.



8
9
10
 
# File 'api_gateway/access_log_field.rb', line 8

def initialize
  Jsii::Object.instance_method(:initialize).bind(self).call
end

Class Method Details

.context_account_id ⇒ String

Deprecated.

Use contextCallerAccountId or contextOwnerAccountId instead

The API callers AWS account ID.

Returns:

  • (String) 


21
22
23
 
# File 'api_gateway/access_log_field.rb', line 21

def self.()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextAccountId", [])
end

.context_api_id ⇒ String

The identifier API Gateway assigns to your API.

Returns:

  • (String) 


28
29
30
 
# File 'api_gateway/access_log_field.rb', line 28

def self.context_api_id()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextApiId", [])
end

.context_authenticate_error ⇒ String

The error message returned from an authentication attempt.

Returns:

  • (String) 


35
36
37
 
# File 'api_gateway/access_log_field.rb', line 35

def self.context_authenticate_error()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextAuthenticateError", [])
end

.context_authenticate_latency ⇒ String

The authentication latency in ms.

Returns:

  • (String) 


42
43
44
 
# File 'api_gateway/access_log_field.rb', line 42

def self.context_authenticate_latency()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextAuthenticateLatency", [])
end

.context_authenticate_status ⇒ String

The status code returned from an authentication attempt.

Returns:

  • (String) 


49
50
51
 
# File 'api_gateway/access_log_field.rb', line 49

def self.context_authenticate_status()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextAuthenticateStatus", [])
end

.context_authorize_error ⇒ String

The authorization error message.

Returns:

  • (String) 


56
57
58
 
# File 'api_gateway/access_log_field.rb', line 56

def self.context_authorize_error()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextAuthorizeError", [])
end

.context_authorize_latency ⇒ String

The authorization latency in ms.

Returns:

  • (String) 


63
64
65
 
# File 'api_gateway/access_log_field.rb', line 63

def self.context_authorize_latency()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextAuthorizeLatency", [])
end

.context_authorize_status ⇒ String

The status code returned from an authorization attempt.

Returns:

  • (String) 


140
141
142
 
# File 'api_gateway/access_log_field.rb', line 140

def self.context_authorize_status()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextAuthorizeStatus", [])
end

.context_authorizer(property) ⇒ String

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

Parameters:

  • property (String) —

    key of the context map.

Returns:

  • (String)

See Also:



72
73
74
75
 
# File 'api_gateway/access_log_field.rb', line 72

def self.context_authorizer(property)
  Jsii::Type.check_type(property, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "property")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextAuthorizer", [property])
end

.context_authorizer_claims(property) ⇒ String

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

Parameters:

  • property (String) —

    A property key of the claims.

Returns:

  • (String)

See Also:



82
83
84
85
 
# File 'api_gateway/access_log_field.rb', line 82

def self.context_authorizer_claims(property)
  Jsii::Type.check_type(property, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "property")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextAuthorizerClaims", [property])
end

.context_authorizer_error ⇒ String

The error message returned from an authorizer.

Returns:

  • (String) 


90
91
92
 
# File 'api_gateway/access_log_field.rb', line 90

def self.context_authorizer_error()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextAuthorizerError", [])
end

.context_authorizer_integration_latency ⇒ String

The authorizer latency in ms.

Returns:

  • (String) 


97
98
99
 
# File 'api_gateway/access_log_field.rb', line 97

def self.context_authorizer_integration_latency()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextAuthorizerIntegrationLatency", [])
end

.context_authorizer_integration_status ⇒ String

The status code returned from a Lambda authorizer.

Returns:

  • (String) 


104
105
106
 
# File 'api_gateway/access_log_field.rb', line 104

def self.context_authorizer_integration_status()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextAuthorizerIntegrationStatus", [])
end

.context_authorizer_latency ⇒ String

The authorizer latency in ms.

Returns:

  • (String) 


111
112
113
 
# File 'api_gateway/access_log_field.rb', line 111

def self.context_authorizer_latency()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextAuthorizerLatency", [])
end

.context_authorizer_principal_id ⇒ String

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).

Returns:

  • (String)

See Also:



119
120
121
 
# File 'api_gateway/access_log_field.rb', line 119

def self.context_authorizer_principal_id()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextAuthorizerPrincipalId", [])
end

.context_authorizer_request_id ⇒ String

The AWS endpoint's request ID.

Returns:

  • (String) 


126
127
128
 
# File 'api_gateway/access_log_field.rb', line 126

def self.context_authorizer_request_id()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextAuthorizerRequestId", [])
end

.context_authorizer_status ⇒ String

The status code returned from an authorizer.

Returns:

  • (String) 


133
134
135
 
# File 'api_gateway/access_log_field.rb', line 133

def self.context_authorizer_status()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextAuthorizerStatus", [])
end

.context_aws_endpoint_request_id ⇒ String

The AWS endpoint's request ID.

Returns:

  • (String) 


147
148
149
 
# File 'api_gateway/access_log_field.rb', line 147

def self.context_aws_endpoint_request_id()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextAwsEndpointRequestId", [])
end

.context_caller_account_id ⇒ String

The API callers AWS account ID.

Returns:

  • (String) 


154
155
156
 
# File 'api_gateway/access_log_field.rb', line 154

def self.()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextCallerAccountId", [])
end

.context_connection_id ⇒ String

A unique ID for the connection that can be used to make a callback to the client.

Returns:

  • (String)

See Also:



162
163
164
 
# File 'api_gateway/access_log_field.rb', line 162

def self.context_connection_id()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextConnectionId", [])
end

.context_custom_domain_base_path_matched ⇒ String

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.

Returns:

  • (String)

See Also:



173
174
175
 
# File 'api_gateway/access_log_field.rb', line 173

def self.context_custom_domain_base_path_matched()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextCustomDomainBasePathMatched", [])
end

.context_domain_name ⇒ String

The full domain name used to invoke the API.

This should be the same as the incoming Host header.

Returns:

  • (String) 


182
183
184
 
# File 'api_gateway/access_log_field.rb', line 182

def self.context_domain_name()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextDomainName", [])
end

.context_domain_prefix ⇒ String

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

Returns:

  • (String) 


189
190
191
 
# File 'api_gateway/access_log_field.rb', line 189

def self.context_domain_prefix()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextDomainPrefix", [])
end

.context_error_message ⇒ String

A string containing an API Gateway error message.

Returns:

  • (String) 


196
197
198
 
# File 'api_gateway/access_log_field.rb', line 196

def self.context_error_message()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextErrorMessage", [])
end

.context_error_message_string ⇒ String

The quoted value of $context.error.message, namely "$context.error.message".

Returns:

  • (String) 


203
204
205
 
# File 'api_gateway/access_log_field.rb', line 203

def self.context_error_message_string()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextErrorMessageString", [])
end

.context_error_response_type ⇒ String

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.

Returns:

  • (String)

See Also:



214
215
216
 
# File 'api_gateway/access_log_field.rb', line 214

def self.context_error_response_type()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextErrorResponseType", [])
end

.context_error_validation_error_string ⇒ String

A string containing a detailed validation error message.

Returns:

  • (String) 


221
222
223
 
# File 'api_gateway/access_log_field.rb', line 221

def self.context_error_validation_error_string()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextErrorValidationErrorString", [])
end

.context_event_type ⇒ String

The event type: CONNECT, MESSAGE, or DISCONNECT.

Returns:

  • (String)

See Also:



229
230
231
 
# File 'api_gateway/access_log_field.rb', line 229

def self.context_event_type()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextEventType", [])
end

.context_extended_request_id ⇒ String

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

Returns:

  • (String) 


236
237
238
 
# File 'api_gateway/access_log_field.rb', line 236

def self.context_extended_request_id()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextExtendedRequestId", [])
end

.context_http_method ⇒ String

The HTTP method used.

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

Returns:

  • (String) 


245
246
247
 
# File 'api_gateway/access_log_field.rb', line 245

def self.context_http_method()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextHttpMethod", [])
end

.context_identity_account_id ⇒ String

The AWS account ID associated with the request.

Returns:

  • (String) 


252
253
254
 
# File 'api_gateway/access_log_field.rb', line 252

def self.()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextIdentityAccountId", [])
end

.context_identity_api_key ⇒ String

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

Returns:

  • (String)

See Also:



262
263
264
 
# File 'api_gateway/access_log_field.rb', line 262

def self.context_identity_api_key()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextIdentityApiKey", [])
end

.context_identity_api_key_id ⇒ String

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

Returns:

  • (String) 


269
270
271
 
# File 'api_gateway/access_log_field.rb', line 269

def self.context_identity_api_key_id()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextIdentityApiKeyId", [])
end

.context_identity_caller ⇒ String

The principal identifier of the caller making the request.

Returns:

  • (String) 


276
277
278
 
# File 'api_gateway/access_log_field.rb', line 276

def self.context_identity_caller()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextIdentityCaller", [])
end

.context_identity_client_cert_issuner_dn ⇒ String

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

Present when a client accesses an API by using a custom domain name that has mutual TLS enabled. Present only in access logs if mutual TLS authentication fails.

Returns:

  • (String) 


286
287
288
 
# File 'api_gateway/access_log_field.rb', line 286

def self.context_identity_client_cert_issuner_dn()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextIdentityClientCertIssunerDN", [])
end

.context_identity_client_cert_pem ⇒ String

The PEM-encoded client certificate that the client presented during mutual TLS authentication.

Present when a client accesses an API by using a custom domain name that has mutual TLS enabled. Present only in access logs if mutual TLS authentication fails.

Returns:

  • (String) 


296
297
298
 
# File 'api_gateway/access_log_field.rb', line 296

def self.context_identity_client_cert_pem()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextIdentityClientCertPem", [])
end

.context_identity_client_cert_serial_number ⇒ String

The serial number of the certificate.

Present when a client accesses an API by using a custom domain name that has mutual TLS enabled. Present only in access logs if mutual TLS authentication fails.

Returns:

  • (String) 


306
307
308
 
# File 'api_gateway/access_log_field.rb', line 306

def self.context_identity_client_cert_serial_number()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextIdentityClientCertSerialNumber", [])
end

.context_identity_client_cert_subject_dn ⇒ String

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

Present when a client accesses an API by using a custom domain name that has mutual TLS enabled. Present only in access logs if mutual TLS authentication fails.

Returns:

  • (String) 


316
317
318
 
# File 'api_gateway/access_log_field.rb', line 316

def self.context_identity_client_cert_subject_dn()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextIdentityClientCertSubjectDN", [])
end

.context_identity_client_cert_validity_not_after ⇒ String

The date after which the certificate is invalid.

Present when a client accesses an API by using a custom domain name that has mutual TLS enabled. Present only in access logs if mutual TLS authentication fails.

Returns:

  • (String) 


326
327
328
 
# File 'api_gateway/access_log_field.rb', line 326

def self.context_identity_client_cert_validity_not_after()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextIdentityClientCertValidityNotAfter", [])
end

.context_identity_client_cert_validity_not_before ⇒ String

The date before which the certificate is invalid.

Present when a client accesses an API by using a custom domain name that has mutual TLS enabled. Present only in access logs if mutual TLS authentication fails.

Returns:

  • (String) 


336
337
338
 
# File 'api_gateway/access_log_field.rb', line 336

def self.context_identity_client_cert_validity_not_before()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextIdentityClientCertValidityNotBefore", [])
end

.context_identity_cognito_authentication_provider ⇒ String

The Amazon Cognito authentication provider used by the caller making the request.

Available only if the request was signed with Amazon Cognito credentials.

Returns:

  • (String)

See Also:



346
347
348
 
# File 'api_gateway/access_log_field.rb', line 346

def self.context_identity_cognito_authentication_provider()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextIdentityCognitoAuthenticationProvider", [])
end

.context_identity_cognito_authentication_type ⇒ String

The Amazon Cognito authentication type of the caller making the request.

Available only if the request was signed with Amazon Cognito credentials.

Returns:

  • (String) 


355
356
357
 
# File 'api_gateway/access_log_field.rb', line 355

def self.context_identity_cognito_authentication_type()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextIdentityCognitoAuthenticationType", [])
end

.context_identity_cognito_identity_id ⇒ String

The Amazon Cognito identity ID of the caller making the request.

Available only if the request was signed with Amazon Cognito credentials.

Returns:

  • (String) 


364
365
366
 
# File 'api_gateway/access_log_field.rb', line 364

def self.context_identity_cognito_identity_id()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextIdentityCognitoIdentityId", [])
end

.context_identity_cognito_identity_pool_id ⇒ String

The Amazon Cognito identity pool ID of the caller making the request.

Available only if the request was signed with Amazon Cognito credentials.

Returns:

  • (String) 


373
374
375
 
# File 'api_gateway/access_log_field.rb', line 373

def self.context_identity_cognito_identity_pool_id()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextIdentityCognitoIdentityPoolId", [])
end

.context_identity_principal_org_id ⇒ String

The AWS organization ID.

Returns:

  • (String) 


380
381
382
 
# File 'api_gateway/access_log_field.rb', line 380

def self.context_identity_principal_org_id()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextIdentityPrincipalOrgId", [])
end

.context_identity_source_ip ⇒ String

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.

Returns:

  • (String) 


389
390
391
 
# File 'api_gateway/access_log_field.rb', line 389

def self.context_identity_source_ip()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextIdentitySourceIp", [])
end

.context_identity_user ⇒ String

The principal identifier of the user making the request.

Used in Lambda authorizers.

Returns:

  • (String)

See Also:



399
400
401
 
# File 'api_gateway/access_log_field.rb', line 399

def self.context_identity_user()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextIdentityUser", [])
end

.context_identity_user_agent ⇒ String

The User-Agent header of the API caller.

Returns:

  • (String) 


406
407
408
 
# File 'api_gateway/access_log_field.rb', line 406

def self.context_identity_user_agent()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextIdentityUserAgent", [])
end

.context_identity_user_arn ⇒ String

The Amazon Resource Name (ARN) of the effective user identified after authentication.

Returns:

  • (String)

See Also:



414
415
416
 
# File 'api_gateway/access_log_field.rb', line 414

def self.context_identity_user_arn()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextIdentityUserArn", [])
end

.context_integration_error_message ⇒ String

A string that contains an integration error message.

Returns:

  • (String) 


421
422
423
 
# File 'api_gateway/access_log_field.rb', line 421

def self.context_integration_error_message()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextIntegrationErrorMessage", [])
end

.context_integration_latency ⇒ String

The integration latency in ms.

Returns:

  • (String) 


428
429
430
 
# File 'api_gateway/access_log_field.rb', line 428

def self.context_integration_latency()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextIntegrationLatency", [])
end

.context_integration_status ⇒ String

For Lambda proxy integration, this parameter represents the status code returned from AWS Lambda, not from the backend Lambda function.

Returns:

  • (String) 


435
436
437
 
# File 'api_gateway/access_log_field.rb', line 435

def self.context_integration_status()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextIntegrationStatus", [])
end

.context_owner_account_id ⇒ String

The API owner's AWS account ID.

Returns:

  • (String) 


442
443
444
 
# File 'api_gateway/access_log_field.rb', line 442

def self.()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextOwnerAccountId", [])
end

.context_path ⇒ String

The request path.

For example, for a non-proxy request URL of https://rest-api-idrest-api-id.execute-apirest-api-id.execute-api.{region.amazonaws.com/stage/root/child, this value is /stage/root/child.

Returns:

  • (String) 


452
453
454
 
# File 'api_gateway/access_log_field.rb', line 452

def self.context_path()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextPath", [])
end

.context_protocol ⇒ String

The request protocol, for example, HTTP/1.1.

Returns:

  • (String) 


459
460
461
 
# File 'api_gateway/access_log_field.rb', line 459

def self.context_protocol()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextProtocol", [])
end

.context_request_id ⇒ String

The ID that API Gateway assigns to the API request.

Returns:

  • (String) 


466
467
468
 
# File 'api_gateway/access_log_field.rb', line 466

def self.context_request_id()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextRequestId", [])
end

.context_request_override_header(header_name) ⇒ String

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:

  • header_name (String)

Returns:

  • (String)

See Also:



477
478
479
480
 
# File 'api_gateway/access_log_field.rb', line 477

def self.context_request_override_header(header_name)
  Jsii::Type.check_type(header_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "headerName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextRequestOverrideHeader", [header_name])
end

.context_request_override_path(path_name) ⇒ String

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:

  • path_name (String)

Returns:

  • (String)

See Also:



490
491
492
493
 
# File 'api_gateway/access_log_field.rb', line 490

def self.context_request_override_path(path_name)
  Jsii::Type.check_type(path_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pathName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextRequestOverridePath", [path_name])
end

.context_request_override_querystring(querystring_name) ⇒ String

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:

  • querystring_name (String)

Returns:

  • (String) 


502
503
504
505
 
# File 'api_gateway/access_log_field.rb', line 502

def self.context_request_override_querystring(querystring_name)
  Jsii::Type.check_type(querystring_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "querystringName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextRequestOverrideQuerystring", [querystring_name])
end

.context_request_time ⇒ String

The CLF-formatted request time (dd/MMM/yyyy:HH:mm:ss +-hhmm).

Returns:

  • (String) 


510
511
512
 
# File 'api_gateway/access_log_field.rb', line 510

def self.context_request_time()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextRequestTime", [])
end

.context_request_time_epoch ⇒ String

The Epoch-formatted request time.

Returns:

  • (String) 


517
518
519
 
# File 'api_gateway/access_log_field.rb', line 517

def self.context_request_time_epoch()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextRequestTimeEpoch", [])
end

.context_resource_id ⇒ String

The identifier that API Gateway assigns to your resource.

Returns:

  • (String) 


524
525
526
 
# File 'api_gateway/access_log_field.rb', line 524

def self.context_resource_id()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextResourceId", [])
end

.context_resource_path ⇒ String

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.

Returns:

  • (String)

See Also:



535
536
537
 
# File 'api_gateway/access_log_field.rb', line 535

def self.context_resource_path()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextResourcePath", [])
end

.context_response_latency ⇒ String

The response latency in ms.

Returns:

  • (String) 


542
543
544
 
# File 'api_gateway/access_log_field.rb', line 542

def self.context_response_latency()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextResponseLatency", [])
end

.context_response_length ⇒ String

The response payload length.

Returns:

  • (String) 


549
550
551
 
# File 'api_gateway/access_log_field.rb', line 549

def self.context_response_length()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextResponseLength", [])
end

.context_response_override_header(header_name) ⇒ String

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:

  • header_name (String)

Returns:

  • (String)

See Also:



561
562
563
564
 
# File 'api_gateway/access_log_field.rb', line 561

def self.context_response_override_header(header_name)
  Jsii::Type.check_type(header_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "headerName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextResponseOverrideHeader", [header_name])
end

.context_response_override_status ⇒ String

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.

Returns:

  • (String)

See Also:



573
574
575
 
# File 'api_gateway/access_log_field.rb', line 573

def self.context_response_override_status()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextResponseOverrideStatus", [])
end

.context_route_key ⇒ String

The selected route key.

Returns:

  • (String)

See Also:



581
582
583
 
# File 'api_gateway/access_log_field.rb', line 581

def self.context_route_key()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextRouteKey", [])
end

.context_stage ⇒ String

The deployment stage of the API request (for example, Beta or Prod).

Returns:

  • (String) 


588
589
590
 
# File 'api_gateway/access_log_field.rb', line 588

def self.context_stage()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextStage", [])
end

.context_status ⇒ String

The method response status.

Returns:

  • (String) 


595
596
597
 
# File 'api_gateway/access_log_field.rb', line 595

def self.context_status()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextStatus", [])
end

.context_waf_error ⇒ String

The error message returned from AWS WAF.

Returns:

  • (String) 


602
603
604
 
# File 'api_gateway/access_log_field.rb', line 602

def self.context_waf_error()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextWafError", [])
end

.context_waf_latency ⇒ String

The AWS WAF latency in ms.

Returns:

  • (String) 


609
610
611
 
# File 'api_gateway/access_log_field.rb', line 609

def self.context_waf_latency()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextWafLatency", [])
end

.context_waf_response_code ⇒ String

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.

Returns:

  • (String)

See Also:



619
620
621
 
# File 'api_gateway/access_log_field.rb', line 619

def self.context_waf_response_code()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextWafResponseCode", [])
end

.context_waf_status ⇒ String

The status code returned from AWS WAF.

Returns:

  • (String) 


626
627
628
 
# File 'api_gateway/access_log_field.rb', line 626

def self.context_waf_status()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextWafStatus", [])
end

.context_webacl_arn ⇒ String

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.

Returns:

  • (String)

See Also:



636
637
638
 
# File 'api_gateway/access_log_field.rb', line 636

def self.context_webacl_arn()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextWebaclArn", [])
end

.context_xray_trace_id ⇒ String

The trace ID for the X-Ray trace.

Returns:

  • (String)

See Also:



644
645
646
 
# File 'api_gateway/access_log_field.rb', line 644

def self.context_xray_trace_id()
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.AccessLogField", "contextXrayTraceId", [])
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
 
# File 'api_gateway/access_log_field.rb', line 12

def self.jsii_overridable_methods
  {
  }
end