1.204.0

class AccessLogFormat

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.AccessLogFormat
Javasoftware.amazon.awscdk.services.apigateway.AccessLogFormat
Pythonaws_cdk.aws_apigateway.AccessLogFormat
TypeScript (source)@aws-cdk/aws-apigateway » AccessLogFormat

factory methods for access log format.

Example

const logGroup = new logs.LogGroup(this, "ApiGatewayAccessLogs");
new apigateway.RestApi(this, 'books', {
  deployOptions: {
    accessLogDestination: new apigateway.LogGroupLogDestination(logGroup),
    accessLogFormat: apigateway.AccessLogFormat.custom(
      `${apigateway.AccessLogField.contextRequestId()} ${apigateway.AccessLogField.contextErrorMessage()} ${apigateway.AccessLogField.contextErrorMessageString()}`
    )
  }
});

Methods

NameDescription
toString()Output a format string to be used with CloudFormation.
static clf()Generate Common Log Format.
static custom(format)Custom log format.
static jsonWithStandardFields(fields?)Access log will be produced in the JSON format with a set of fields most useful in the access log.

toString()

public toString(): string

Returns

  • string

Output a format string to be used with CloudFormation.

static clf()

public static clf(): AccessLogFormat

Returns

Generate Common Log Format.

static custom(format)

public static custom(format: string): AccessLogFormat

Parameters

  • format string

Returns

Custom log format.

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

 apigateway.AccessLogFormat.custom(JSON.stringify({
     requestId: apigateway.AccessLogField.contextRequestId(),
     sourceIp: apigateway.AccessLogField.contextIdentitySourceIp(),
     method: apigateway.AccessLogField.contextHttpMethod(),
     userContext: {
       sub: apigateway.AccessLogField.contextAuthorizerClaims('sub'),
       email: apigateway.AccessLogField.contextAuthorizerClaims('email')
     }
  }))

static jsonWithStandardFields(fields?)

public static jsonWithStandardFields(fields?: JsonWithStandardFieldProps): AccessLogFormat

Parameters

Returns

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.

← PreviousNext →