Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

AWS::ApiGatewayV2::Stage AccessLogSettings

Focus mode
AWS::ApiGatewayV2::Stage AccessLogSettings - AWS CloudFormation
Filter View

Settings for logging access in a stage.

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 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

On this page

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.