Interface CfnGraphQLApi.LogConfigProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnGraphQLApi.LogConfigProperty.Jsii$Proxy
Enclosing class:
CfnGraphQLApi

@Stability(Stable) public static interface CfnGraphQLApi.LogConfigProperty extends software.amazon.jsii.JsiiSerializable
The LogConfig property type specifies the logging configuration when writing GraphQL operations and tracing to Amazon CloudWatch for an AWS AppSync GraphQL API.

LogConfig is a property of the AWS::AppSync::GraphQLApi property type.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appsync.*;
 LogConfigProperty logConfigProperty = LogConfigProperty.builder()
         .cloudWatchLogsRoleArn("cloudWatchLogsRoleArn")
         .excludeVerboseContent(false)
         .fieldLogLevel("fieldLogLevel")
         .build();
 
  • Method Details

    • getCloudWatchLogsRoleArn

      @Stability(Stable) @Nullable default String getCloudWatchLogsRoleArn()
      The service role that AWS AppSync will assume to publish to Amazon CloudWatch Logs in your account.
    • getExcludeVerboseContent

      @Stability(Stable) @Nullable default Object getExcludeVerboseContent()
      Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
    • getFieldLogLevel

      @Stability(Stable) @Nullable default String getFieldLogLevel()
      The field logging level. Values can be NONE, ERROR, or ALL.

      • NONE : No field-level logs are captured.
      • ERROR : Logs the following information only for the fields that are in error:
      • The error section in the server response.
      • Field-level errors.
      • The generated request/response functions that got resolved for error fields.
      • ALL : The following information is logged for all fields in the query:
      • Field-level tracing information.
      • The generated request/response functions that got resolved for each field.
    • builder

      @Stability(Stable) static CfnGraphQLApi.LogConfigProperty.Builder builder()
      Returns:
      a CfnGraphQLApi.LogConfigProperty.Builder of CfnGraphQLApi.LogConfigProperty