aws-cdk-lib.aws_appsync.LogConfig

interface LogConfig

LanguageType name
.NETAmazon.CDK.AWS.AppSync.LogConfig
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappsync#LogConfig
Javasoftware.amazon.awscdk.services.appsync.LogConfig
Pythonaws_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';

const logConfig: appsync.LogConfig = {
  retention: logs.RetentionDays.ONE_WEEK,
};

new appsync.GraphqlApi(this, 'api', {
  authorizationConfig: {},
  name: 'myApi',
  schema: appsync.SchemaFile.fromAsset(path.join(__dirname, 'myApi.graphql')),
  logConfig,
});

Properties

NameTypeDescription
excludeVerboseContent?boolean | IResolvableexclude verbose content.
fieldLogLevel?FieldLogLevellog level for fields.
retention?RetentionDaysThe number of days log events are kept in CloudWatch Logs.
role?IRoleThe 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.