interface LogConfigProperty

Language	Type name
.NET	`Amazon.CDK.AWS.AppSync.CfnGraphQLApi.LogConfigProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#CfnGraphQLApi_LogConfigProperty`
Java	`software.amazon.awscdk.services.appsync.CfnGraphQLApi.LogConfigProperty`
Python	`aws_cdk.aws_appsync.CfnGraphQLApi.LogConfigProperty`
TypeScript	`aws-cdk-lib` » `aws_appsync` » `CfnGraphQLApi` » `LogConfigProperty`

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

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
const logConfigProperty: appsync.CfnGraphQLApi.LogConfigProperty = {
  cloudWatchLogsRoleArn: 'cloudWatchLogsRoleArn',
  excludeVerboseContent: false,
  fieldLogLevel: 'fieldLogLevel',
};

Properties

Name	Type	Description
cloudWatchLogsRoleArn?	`string`	The service role that AWS AppSync will assume to publish to Amazon CloudWatch Logs in your account.
excludeVerboseContent?	`boolean \|` `IResolvable`	Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
fieldLogLevel?	`string`	The field logging level. Values can be NONE, ERROR, INFO, DEBUG, or ALL.

cloudWatchLogsRoleArn?

Type: string (optional)

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

excludeVerboseContent?

Type: boolean | IResolvable (optional)

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

fieldLogLevel?

Type: string (optional)

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.