aws-cdk-lib.aws_appsync.AppSyncLogConfig

AppSyncLogConfig Struct

Logging configuration for AppSync.

Source

aws-appsync/lib/appsync-common.ts

Type last changed

v2.224.0 · 13 Nov 2025

Example

import * as logs from 'aws-cdk-lib/aws-logs';

const apiKeyProvider: appsync.AppSyncAuthProvider = {
  authorizationType: appsync.AppSyncAuthorizationType.API_KEY,
};

const api = new appsync.EventApi(this, 'api', {
  apiName: 'Api',
  ownerContact: 'OwnerContact',
  authorizationConfig: {
    authProviders: [
      apiKeyProvider,
    ],
    connectionAuthModeTypes: [
      appsync.AppSyncAuthorizationType.API_KEY,
    ],
    defaultPublishAuthModeTypes: [
      appsync.AppSyncAuthorizationType.API_KEY,
    ],
    defaultSubscribeAuthModeTypes: [
      appsync.AppSyncAuthorizationType.API_KEY,
    ],
  },
  logConfig: {
    fieldLogLevel: appsync.AppSyncFieldLogLevel.INFO,
    retention: logs.RetentionDays.ONE_WEEK,
  },
});

api.addChannelNamespace('default');

Properties

excludeVerboseContent?optionalbooleanexclude_verbose_content?optionalboolexcludeVerboseContent?optionalBooleanExcludeVerboseContent?optionalboolExcludeVerboseContent?optional*bool= false#

exclude verbose content.

fieldLogLevel?optionalAppSyncFieldLogLevelfield_log_level?optionalAppSyncFieldLogLevelfieldLogLevel?optionalAppSyncFieldLogLevelFieldLogLevel?optionalAppSyncFieldLogLevelFieldLogLevel?optionalAppSyncFieldLogLevel#

log level for fields.

Default: Use AppSync default

retention?optionalRetentionDaysretention?optionalRetentionDaysretention?optionalRetentionDaysRetention?optionalRetentionDaysRetention?optionalRetentionDays= RetentionDays.INFINITE#

The number of days log events are kept in CloudWatch Logs.

By default AppSync keeps the logs infinitely. When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to INFINITE

role?optionalIRoleRefrole?optionalIRoleRefrole?optionalIRoleRefRole?optionalIRoleRefRole?optionalIRoleRef= None#

The role for CloudWatch Logs.