ResolverArgs

data class ResolverArgs(val apiId: Output<String>? = null, val cachingConfig: Output<ResolverCachingConfigArgs>? = null, val code: Output<String>? = null, val codeS3Location: Output<String>? = null, val dataSourceName: Output<String>? = null, val fieldName: Output<String>? = null, val kind: Output<String>? = null, val maxBatchSize: Output<Int>? = null, val metricsConfig: Output<ResolverMetricsConfig>? = null, val pipelineConfig: Output<ResolverPipelineConfigArgs>? = null, val requestMappingTemplate: Output<String>? = null, val requestMappingTemplateS3Location: Output<String>? = null, val responseMappingTemplate: Output<String>? = null, val responseMappingTemplateS3Location: Output<String>? = null, val runtime: Output<ResolverAppSyncRuntimeArgs>? = null, val syncConfig: Output<ResolverSyncConfigArgs>? = null, val typeName: Output<String>? = null) : ConvertibleToJava<ResolverArgs>

The `AWS::AppSync::Resolver` resource defines the logical GraphQL resolver that you attach to fields in a schema. Request and response templates for resolvers are written in Apache Velocity Template Language (VTL) format. For more information about resolvers, see Resolver Mapping Template Reference. When you submit an update, CFNLong updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CFNshort template. Changing the S3 file content without changing a property value will not result in an update operation. See Update Behaviors of Stack Resources in the User Guide.

Example Usage

Example

No Java example available.

Constructors

Link copied to clipboard
constructor(apiId: Output<String>? = null, cachingConfig: Output<ResolverCachingConfigArgs>? = null, code: Output<String>? = null, codeS3Location: Output<String>? = null, dataSourceName: Output<String>? = null, fieldName: Output<String>? = null, kind: Output<String>? = null, maxBatchSize: Output<Int>? = null, metricsConfig: Output<ResolverMetricsConfig>? = null, pipelineConfig: Output<ResolverPipelineConfigArgs>? = null, requestMappingTemplate: Output<String>? = null, requestMappingTemplateS3Location: Output<String>? = null, responseMappingTemplate: Output<String>? = null, responseMappingTemplateS3Location: Output<String>? = null, runtime: Output<ResolverAppSyncRuntimeArgs>? = null, syncConfig: Output<ResolverSyncConfigArgs>? = null, typeName: Output<String>? = null)

Properties

Link copied to clipboard
val apiId: Output<String>? = null

The APSYlong GraphQL API to which you want to attach this resolver.

Link copied to clipboard

The caching configuration for the resolver.

Link copied to clipboard
val code: Output<String>? = null

The `resolver` code that contains the request and response functions. When code is used, the `runtime` is required. The runtime value must be `APPSYNC_JS`.

Link copied to clipboard
val codeS3Location: Output<String>? = null

The Amazon S3 endpoint.

Link copied to clipboard
val dataSourceName: Output<String>? = null

The resolver data source name.

Link copied to clipboard
val fieldName: Output<String>? = null

The GraphQL field on a type that invokes the resolver.

Link copied to clipboard
val kind: Output<String>? = null

The resolver type.

Link copied to clipboard
val maxBatchSize: Output<Int>? = null

The maximum number of resolver request inputs that will be sent to a single LAMlong function in a `BatchInvoke` operation.

Link copied to clipboard

Enables or disables enhanced resolver metrics for specified resolvers. Note that `MetricsConfig` won't be used unless the `resolverLevelMetricsBehavior` value is set to `PER_RESOLVER_METRICS`. If the `resolverLevelMetricsBehavior` is set to `FULL_REQUEST_RESOLVER_METRICS` instead, `MetricsConfig` will be ignored. However, you can still set its value.

Link copied to clipboard

Functions linked with the pipeline resolver.

Link copied to clipboard
val requestMappingTemplate: Output<String>? = null

The request mapping template. Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.

Link copied to clipboard

The location of a request mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template.

Link copied to clipboard
val responseMappingTemplate: Output<String>? = null

The response mapping template.

Link copied to clipboard

The location of a response mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template.

Link copied to clipboard
val runtime: Output<ResolverAppSyncRuntimeArgs>? = null

Describes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.

Link copied to clipboard
val syncConfig: Output<ResolverSyncConfigArgs>? = null

The `SyncConfig` for a resolver attached to a versioned data source.

Link copied to clipboard
val typeName: Output<String>? = null

The GraphQL type that invokes this resolver.

Functions

Link copied to clipboard
open override fun toJava(): ResolverArgs