AWS::AppSync::GraphQLApi LogConfig - Amazon CloudFormation
SyntaxProperties
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).

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

AWS::AppSync::GraphQLApi LogConfig

The LogConfig property type specifies the logging configuration when writing GraphQL operations and tracing to Amazon CloudWatch for an Amazon AppSync GraphQL API.

LogConfig is a property of the AWS::AppSync::GraphQLApi property type.

Syntax

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

JSON

{
  "CloudWatchLogsRoleArn" : String,
  "ExcludeVerboseContent" : Boolean,
  "FieldLogLevel" : String
}

Properties

CloudWatchLogsRoleArn

The service role that Amazon AppSync will assume to publish to Amazon CloudWatch Logs in your account.

Required: No

Type: String

Update requires: No interruption

ExcludeVerboseContent

Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.

Required: No

Type: Boolean

Update requires: No interruption

FieldLogLevel

The field logging level. Values can be NONE, ERROR, INFO, DEBUG, or ALL.

  • NONE: No field-level logs are captured.

  • ERROR: Logs the following information only for the fields that are in the error category:

    • The error section in the server response.

    • Field-level errors.

    • The generated request/response functions that got resolved for error fields.

  • INFO: Logs the following information only for the fields that are in the info and error categories:

    • Info-level messages.

    • The user messages sent through $util.log.info and console.log.

    • Field-level tracing and mapping logs are not shown.

  • DEBUG: Logs the following information only for the fields that are in the debug, info, and error categories:

    • Debug-level messages.

    • The user messages sent through $util.log.info, $util.log.debug, console.log, and console.debug.

    • Field-level tracing and mapping logs are not shown.

  • ALL: The following information is logged for all fields in the query:

    • Field-level tracing information.

    • The generated request/response functions that were resolved for each field.

Required: No

Type: String

Allowed values: NONE | ERROR | ALL | INFO | DEBUG

Update requires: No interruption