AWS::ApiGatewayV2::Stage AccessLogSettings - AWS CloudFormation
SyntaxPropertiesSee also
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::ApiGatewayV2::Stage AccessLogSettings

Settings for logging access in a stage.

Syntax

To declare this entity in your 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