You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb

Overview

Note:

When making an API call, you may pass CreateResolverRequest data as a hash:

{
  api_id: "String", # required
  type_name: "ResourceName", # required
  field_name: "ResourceName", # required
  data_source_name: "ResourceName",
  request_mapping_template: "MappingTemplate", # required
  response_mapping_template: "MappingTemplate",
  kind: "UNIT", # accepts UNIT, PIPELINE
  pipeline_config: {
    functions: ["String"],
  },
  sync_config: {
    conflict_handler: "OPTIMISTIC_CONCURRENCY", # accepts OPTIMISTIC_CONCURRENCY, LAMBDA, AUTOMERGE, NONE
    conflict_detection: "VERSION", # accepts VERSION, NONE
    lambda_conflict_handler_config: {
      lambda_conflict_handler_arn: "String",
    },
  },
  caching_config: {
    ttl: 1,
    caching_keys: ["String"],
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#api_idString

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

Returns:

  • (String)


878
879
880
881
882
883
884
885
886
887
888
889
890
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 878

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)
  include Aws::Structure
end

#caching_configTypes::CachingConfig

The caching configuration for the resolver.



878
879
880
881
882
883
884
885
886
887
888
889
890
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 878

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)
  include Aws::Structure
end

#data_source_nameString

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

Returns:

  • (String)


878
879
880
881
882
883
884
885
886
887
888
889
890
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 878

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)
  include Aws::Structure
end

#field_nameString

The name of the field to attach the resolver to.

Returns:

  • (String)


878
879
880
881
882
883
884
885
886
887
888
889
890
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 878

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)
  include Aws::Structure
end

#kindString

The resolver type.

  • UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.

  • PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.

Returns:

  • (String)


878
879
880
881
882
883
884
885
886
887
888
889
890
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 878

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)
  include Aws::Structure
end

#pipeline_configTypes::PipelineConfig

The PipelineConfig.



878
879
880
881
882
883
884
885
886
887
888
889
890
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 878

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)
  include Aws::Structure
end

#request_mapping_templateString

The mapping template to be used 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).

Returns:

  • (String)


878
879
880
881
882
883
884
885
886
887
888
889
890
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 878

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)
  include Aws::Structure
end

#response_mapping_templateString

The mapping template to be used for responses from the data source.

Returns:

  • (String)


878
879
880
881
882
883
884
885
886
887
888
889
890
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 878

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)
  include Aws::Structure
end

#sync_configTypes::SyncConfig

The SyncConfig for a resolver attached to a versioned datasource.

Returns:



878
879
880
881
882
883
884
885
886
887
888
889
890
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 878

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)
  include Aws::Structure
end

#type_nameString

The name of the Type.

Returns:

  • (String)


878
879
880
881
882
883
884
885
886
887
888
889
890
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 878

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)
  include Aws::Structure
end