The AccessLogSetting
property type specifies settings for logging access in this stage.
AccessLogSetting
is a property of the StageDescription property type.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"DestinationArn" : String
,
"Format" : String
}
YAML
DestinationArn: String
Format: String
Properties
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-
.Required: No
Type: String
Update requires: No interruption
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
.Required: No
Type: String
Update requires: No interruption
See also
-
accessLogSettings in the Amazon API Gateway REST API Reference