AWS::ApiGatewayV2::Stage AccessLogSettings - 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.

AWS::ApiGatewayV2::Stage AccessLogSettings

Settings for logging access in a stage.

Syntax

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

JSON

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

YAML

DestinationArn: String Format: String

Properties

DestinationArn

The ARN of the CloudWatch Logs log group to receive access logs. This parameter is required to enable access logging.

Required: Conditional

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. This parameter is required to enable access logging.

Required: Conditional

Type: String

Update requires: No interruption

See also

  • Stages in the Amazon API Gateway Version 2 API Reference