Class: Aws::AppSync::Types::CreateResolverRequest

Inherits:

Struct

• Object
• Struct
• Aws::AppSync::Types::CreateResolverRequest

Includes:

Structure

Defined in:

lib/aws-sdk-appsync/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #api_id ⇒ String

  The ID for the GraphQL API for which the resolver is being created.

• #caching_config ⇒ Types::CachingConfig

  The caching configuration for the resolver.

• #code ⇒ String

  The ‘resolver` code that contains the request and response functions.

• #data_source_name ⇒ String

  The name of the data source for which the resolver is being created.

• #field_name ⇒ String

  The name of the field to attach the resolver to.

• #kind ⇒ String

  The resolver type.

• #max_batch_size ⇒ Integer

  The maximum batching size for a resolver.

• #metrics_config ⇒ String

  Enables or disables enhanced resolver metrics for specified resolvers.

• #pipeline_config ⇒ Types::PipelineConfig

  The ‘PipelineConfig`.

• #request_mapping_template ⇒ String

  The mapping template to use for requests.

• #response_mapping_template ⇒ String

  The mapping template to use for responses from the data source.

• #runtime ⇒ Types::AppSyncRuntime

  Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function.

• #sync_config ⇒ Types::SyncConfig

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

• #type_name ⇒ String

  The name of the ‘Type`.

Instance Attribute Details

#api_id ⇒ String

The ID for the GraphQL API for which the resolver is being created.

Returns:

• (String)

# File 'lib/aws-sdk-appsync/types.rb', line 1596

class CreateResolverRequest < Struct.new(
  :api_id,
  :type_name,
  :field_name,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :kind,
  :pipeline_config,
  :sync_config,
  :caching_config,
  :max_batch_size,
  :runtime,
  :code,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#caching_config ⇒ Types::CachingConfig

The caching configuration for the resolver.

Returns:

• (Types::CachingConfig)

# File 'lib/aws-sdk-appsync/types.rb', line 1596

class CreateResolverRequest < Struct.new(
  :api_id,
  :type_name,
  :field_name,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :kind,
  :pipeline_config,
  :sync_config,
  :caching_config,
  :max_batch_size,
  :runtime,
  :code,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#code ⇒ String

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`.

Returns:

• (String)

# File 'lib/aws-sdk-appsync/types.rb', line 1596

class CreateResolverRequest < Struct.new(
  :api_id,
  :type_name,
  :field_name,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :kind,
  :pipeline_config,
  :sync_config,
  :caching_config,
  :max_batch_size,
  :runtime,
  :code,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#data_source_name ⇒ String

The name of the data source for which the resolver is being created.

Returns:

• (String)

# File 'lib/aws-sdk-appsync/types.rb', line 1596

class CreateResolverRequest < Struct.new(
  :api_id,
  :type_name,
  :field_name,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :kind,
  :pipeline_config,
  :sync_config,
  :caching_config,
  :max_batch_size,
  :runtime,
  :code,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#field_name ⇒ String

The name of the field to attach the resolver to.

Returns:

• (String)

# File 'lib/aws-sdk-appsync/types.rb', line 1596

class CreateResolverRequest < Struct.new(
  :api_id,
  :type_name,
  :field_name,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :kind,
  :pipeline_config,
  :sync_config,
  :caching_config,
  :max_batch_size,
  :runtime,
  :code,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#kind ⇒ String

The resolver type.

• UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.

• PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of ‘Function` objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.

Returns:

• (String)

# File 'lib/aws-sdk-appsync/types.rb', line 1596

class CreateResolverRequest < Struct.new(
  :api_id,
  :type_name,
  :field_name,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :kind,
  :pipeline_config,
  :sync_config,
  :caching_config,
  :max_batch_size,
  :runtime,
  :code,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#max_batch_size ⇒ Integer

The maximum batching size for a resolver.

Returns:

• (Integer)

# File 'lib/aws-sdk-appsync/types.rb', line 1596

class CreateResolverRequest < Struct.new(
  :api_id,
  :type_name,
  :field_name,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :kind,
  :pipeline_config,
  :sync_config,
  :caching_config,
  :max_batch_size,
  :runtime,
  :code,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#metrics_config ⇒ String

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.

‘metricsConfig` can be `ENABLED` or `DISABLED`.

Returns:

• (String)

# File 'lib/aws-sdk-appsync/types.rb', line 1596

class CreateResolverRequest < Struct.new(
  :api_id,
  :type_name,
  :field_name,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :kind,
  :pipeline_config,
  :sync_config,
  :caching_config,
  :max_batch_size,
  :runtime,
  :code,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_config ⇒ Types::PipelineConfig

The ‘PipelineConfig`.

Returns:

• (Types::PipelineConfig)

# File 'lib/aws-sdk-appsync/types.rb', line 1596

class CreateResolverRequest < Struct.new(
  :api_id,
  :type_name,
  :field_name,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :kind,
  :pipeline_config,
  :sync_config,
  :caching_config,
  :max_batch_size,
  :runtime,
  :code,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#request_mapping_template ⇒ String

The mapping template to use for requests.

A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).

VTL request mapping templates are optional when using an Lambda data source. For all other data sources, VTL request and response mapping templates are required.

Returns:

• (String)

# File 'lib/aws-sdk-appsync/types.rb', line 1596

class CreateResolverRequest < Struct.new(
  :api_id,
  :type_name,
  :field_name,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :kind,
  :pipeline_config,
  :sync_config,
  :caching_config,
  :max_batch_size,
  :runtime,
  :code,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#response_mapping_template ⇒ String

The mapping template to use for responses from the data source.

Returns:

• (String)

# File 'lib/aws-sdk-appsync/types.rb', line 1596

class CreateResolverRequest < Struct.new(
  :api_id,
  :type_name,
  :field_name,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :kind,
  :pipeline_config,
  :sync_config,
  :caching_config,
  :max_batch_size,
  :runtime,
  :code,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#runtime ⇒ Types::AppSyncRuntime

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

Returns:

• (Types::AppSyncRuntime)

# File 'lib/aws-sdk-appsync/types.rb', line 1596

class CreateResolverRequest < Struct.new(
  :api_id,
  :type_name,
  :field_name,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :kind,
  :pipeline_config,
  :sync_config,
  :caching_config,
  :max_batch_size,
  :runtime,
  :code,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#sync_config ⇒ Types::SyncConfig

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

Returns:

• (Types::SyncConfig)

# File 'lib/aws-sdk-appsync/types.rb', line 1596

class CreateResolverRequest < Struct.new(
  :api_id,
  :type_name,
  :field_name,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :kind,
  :pipeline_config,
  :sync_config,
  :caching_config,
  :max_batch_size,
  :runtime,
  :code,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end

#type_name ⇒ String

The name of the ‘Type`.

Returns:

• (String)

# File 'lib/aws-sdk-appsync/types.rb', line 1596

class CreateResolverRequest < Struct.new(
  :api_id,
  :type_name,
  :field_name,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :kind,
  :pipeline_config,
  :sync_config,
  :caching_config,
  :max_batch_size,
  :runtime,
  :code,
  :metrics_config)
  SENSITIVE = []
  include Aws::Structure
end