Skip to content
v2.274.0

LogConfig Struct ​

Logging configuration for AppSync.

Example ​

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

new appsync.GraphqlApi(this, 'api', {
  authorizationConfig: {},
  name: 'myApi',
  definition: appsync.Definition.fromFile(path.join(__dirname, 'myApi.graphql')),
  logConfig: {
    fieldLogLevel: appsync.FieldLogLevel.INFO,
    retention: logs.RetentionDays.ONE_WEEK,
  },
});

Properties ​

excludeVerboseContentoptionalboolean | IResolvableexclude_verbose_contentoptionaltyping.Union[bool, IResolvable]excludeVerboseContentoptionalBooleanExcludeVerboseContentoptionalboolExcludeVerboseContentoptionalinterface{}= false#
exclude verbose content.
fieldLogLeveloptionalFieldLogLevelfield_log_leveloptionalFieldLogLevelfieldLogLeveloptionalFieldLogLevelFieldLogLeveloptionalFieldLogLevelFieldLogLeveloptionalFieldLogLevel#
log level for fields.

Default: Use AppSync default

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

roleoptionalIRoleRefroleoptionalIRoleRefroleoptionalIRoleRefRoleoptionalIRoleRefRoleoptionalIRoleRef= None#
The role for CloudWatch Logs.