AccessLogSettings - Amazon API Gateway
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AccessLogSettings

Access log settings, including the access log format and access log destination ARN.

Contents

destinationArn

The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-.

Type: String

Required: No

format

A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: