AWS::ApiGateway::Deployment AccessLogSetting - Amazon CloudFormation
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).

AWS::ApiGateway::Deployment AccessLogSetting

The AccessLogSetting property type specifies settings for logging access in this stage.

AccessLogSetting is a property of the StageDescription property type.


To declare this entity in your Amazon CloudFormation template, use the following syntax:


{ "DestinationArn" : String, "Format" : String }


DestinationArn: String Format: String



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


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