LogConfig Struct
Logging configuration for AppSync.
| Source | aws-appsync/lib/graphqlapi.ts |
|---|---|
| Type last changed |
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,
},
});
python
import aws_cdk.aws_logs as logs
appsync.GraphqlApi(self, "api",
authorization_config=appsync.AuthorizationConfig(),
name="myApi",
definition=appsync.Definition.from_file(path.join(__dirname, "myApi.graphql")),
log_config=appsync.LogConfig(
field_log_level=appsync.FieldLogLevel.INFO,
retention=logs.RetentionDays.ONE_WEEK
)
)
java
import software.amazon.awscdk.services.logs.*;
GraphqlApi.Builder.create(this, "api")
.authorizationConfig(AuthorizationConfig.builder().build())
.name("myApi")
.definition(Definition.fromFile(join(__dirname, "myApi.graphql")))
.logConfig(LogConfig.builder()
.fieldLogLevel(FieldLogLevel.INFO)
.retention(RetentionDays.ONE_WEEK)
.build())
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.Logs;
new GraphqlApi(this, "api", new GraphqlApiProps {
AuthorizationConfig = new AuthorizationConfig { },
Name = "myApi",
Definition = Definition.FromFile(Join(__dirname, "myApi.graphql")),
LogConfig = new LogConfig {
FieldLogLevel = FieldLogLevel.INFO,
Retention = RetentionDays.ONE_WEEK
}
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import logs "github.com/aws/aws-cdk-go/awscdk"
appsync.NewGraphqlApi(this, jsii.String("api"), &GraphqlApiProps{
AuthorizationConfig: &AuthorizationConfig{
},
Name: jsii.String("myApi"),
Definition: appsync.Definition_FromFile(path.join(__dirname, jsii.String("myApi.graphql"))),
LogConfig: &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