Package software.amazon.awscdk.services.appsync

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-logconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGraphQLApi.LogConfigProperty.Builder	A builder for CfnGraphQLApi.LogConfigProperty
static final class	CfnGraphQLApi.LogConfigProperty.Jsii$Proxy	An implementation for CfnGraphQLApi.LogConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnGraphQLApi.LogConfigProperty.Builder	builder()
default String	getCloudWatchLogsRoleArn()	The service role that AWS AppSync will assume to publish to Amazon CloudWatch Logs in your account.
default Object	getExcludeVerboseContent()	Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
default String	getFieldLogLevel()	The field logging level.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-logconfig.html#cfn-appsync-graphqlapi-logconfig-cloudwatchlogsrolearn

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.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-logconfig.html#cfn-appsync-graphqlapi-logconfig-excludeverbosecontent

getFieldLogLevel

@Stability(Stable)
@Nullable
default String getFieldLogLevel()

The field logging level. Values can be NONE, ERROR, INFO, DEBUG, or ALL.

• NONE : No field-level logs are captured.
• ERROR : Logs the following information only for the fields that are in the error category:
• The error section in the server response.
• Field-level errors.
• The generated request/response functions that got resolved for error fields.
• INFO : Logs the following information only for the fields that are in the info and error categories:
• Info-level messages.
• The user messages sent through $util.log.info and console.log .
• Field-level tracing and mapping logs are not shown.
• DEBUG : Logs the following information only for the fields that are in the debug, info, and error categories:
• Debug-level messages.
• The user messages sent through $util.log.info , $util.log.debug , console.log , and console.debug .
• Field-level tracing and mapping logs are not shown.
• ALL : The following information is logged for all fields in the query:
• Field-level tracing information.
• The generated request/response functions that were resolved for each field.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-logconfig.html#cfn-appsync-graphqlapi-logconfig-fieldloglevel

builder

@Stability(Stable)
static CfnGraphQLApi.LogConfigProperty.Builder builder()

Returns:

a CfnGraphQLApi.LogConfigProperty.Builder of CfnGraphQLApi.LogConfigProperty