software.amazon.awscdk.services.apigateway

Class AccessLogFormat

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigateway.AccessLogFormat

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-28T18:14:42.652Z")
public class AccessLogFormat
extends software.amazon.jsii.JsiiObject

factory methods for access log format.

Example:

 LogGroup logGroup = new LogGroup(this, "ApiGatewayAccessLogs");
 RestApi.Builder.create(this, "books")
         .deployOptions(StageOptions.builder()
                 .accessLogDestination(new LogGroupLogDestination(logGroup))
                 .accessLogFormat(AccessLogFormat.custom(String.format("%s %s %s", AccessLogField.contextRequestId(), AccessLogField.contextErrorMessage(), AccessLogField.contextErrorMessageString())))
                 .build())
         .build();
 

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static AccessLogFormat	clf() Generate Common Log Format.
static AccessLogFormat	custom(java.lang.String format) Custom log format.
static AccessLogFormat	jsonWithStandardFields() Access log will be produced in the JSON format with a set of fields most useful in the access log.
static AccessLogFormat	jsonWithStandardFields(JsonWithStandardFieldProps fields) Access log will be produced in the JSON format with a set of fields most useful in the access log.
java.lang.String	toString() Output a format string to be used with CloudFormation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AccessLogFormat

protected AccessLogFormat(software.amazon.jsii.JsiiObjectRef objRef)

AccessLogFormat

protected AccessLogFormat(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

clf

public static AccessLogFormat clf()

Generate Common Log Format.

custom

public static AccessLogFormat custom(java.lang.String format)

Custom log format.

You can create any log format string. You can easily get the $ context variable by using the methods of AccessLogField.

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")))));
 

Parameters:

format - This parameter is required.

jsonWithStandardFields

public static AccessLogFormat jsonWithStandardFields(JsonWithStandardFieldProps fields)

Access log will be produced in the JSON format with a set of fields most useful in the access log.

All fields are turned on by default with the option to turn off specific fields.

Parameters:

fields -

jsonWithStandardFields

public static AccessLogFormat jsonWithStandardFields()

Access log will be produced in the JSON format with a set of fields most useful in the access log.

All fields are turned on by default with the option to turn off specific fields.

toString

public java.lang.String toString()

Output a format string to be used with CloudFormation.