Interface CfnGraphQLApi.EnhancedMetricsConfigProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnGraphQLApi.EnhancedMetricsConfigProperty.Jsii$Proxy
- Enclosing class:
CfnGraphQLApi
@Stability(Stable)
public static interface CfnGraphQLApi.EnhancedMetricsConfigProperty
extends software.amazon.jsii.JsiiSerializable
Describes an enhanced metrics configuration.
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.*; EnhancedMetricsConfigProperty enhancedMetricsConfigProperty = EnhancedMetricsConfigProperty.builder() .dataSourceLevelMetricsBehavior("dataSourceLevelMetricsBehavior") .operationLevelMetricsConfig("operationLevelMetricsConfig") .resolverLevelMetricsBehavior("resolverLevelMetricsBehavior") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnGraphQLApi.EnhancedMetricsConfigProperty
static final class
An implementation forCfnGraphQLApi.EnhancedMetricsConfigProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Controls how data source metrics will be emitted to CloudWatch.Controls how operation metrics will be emitted to CloudWatch.Controls how resolver metrics will be emitted to CloudWatch.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDataSourceLevelMetricsBehavior
Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:.- Requests : The number of invocations that occured during a request.
- Latency : The time to complete a data source invocation.
- Errors : The number of errors that occurred during a data source invocation.
These metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics will be recorded by API ID and data source name.
dataSourceLevelMetricsBehavior
accepts one of these values at a time:FULL_REQUEST_DATA_SOURCE_METRICS
: Records and emits metric data for all data sources in the request.PER_DATA_SOURCE_METRICS
: Records and emits metric data for data sources that have theMetricsConfig
value set toENABLED
.
- See Also:
-
getOperationLevelMetricsConfig
Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:.- Requests : The number of times a specified GraphQL operation was called.
- GraphQL errors : The number of GraphQL errors that occurred during a specified GraphQL operation.
Metrics will be recorded by API ID and operation name. You can set the value to
ENABLED
orDISABLED
.- See Also:
-
getResolverLevelMetricsBehavior
Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:.- GraphQL errors : The number of GraphQL errors that occurred.
- Requests : The number of invocations that occurred during a request.
- Latency : The time to complete a resolver invocation.
- Cache hits : The number of cache hits during a request.
- Cache misses : The number of cache misses during a request.
These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be recorded by API ID and resolver name.
resolverLevelMetricsBehavior
accepts one of these values at a time:FULL_REQUEST_RESOLVER_METRICS
: Records and emits metric data for all resolvers in the request.PER_RESOLVER_METRICS
: Records and emits metric data for resolvers that have theMetricsConfig
value set toENABLED
.
- See Also:
-
builder
-