Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon API Gateway Resource Types Reference » AWS::ApiGateway::Deployment » Amazon API Gateway Deployment AccessLogSetting

Amazon API Gateway Deployment AccessLogSetting

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 to receive access logs

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

On this page: