interface LogConfig

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

Logging configuration for AppSync.

Example

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

Name	Type	Description
excludeVerboseContent?	boolean | IResolvable	exclude verbose content.
fieldLogLevel?	FieldLogLevel	log level for fields.
retention?	RetentionDays	The number of days log events are kept in CloudWatch Logs.
role?	IRole	The role for CloudWatch Logs.

---

excludeVerboseContent?

Type: boolean | IResolvable (optional, default: false)

exclude verbose content.

---

fieldLogLevel?

Type: FieldLogLevel (optional, default: Use AppSync default)

log level for fields.

---

retention?

Type: RetentionDays (optional, default: 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?

Type: IRole (optional, default: None)

The role for CloudWatch Logs.