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", # required
  request_mapping_template: "MappingTemplate", # required
  response_mapping_template: "MappingTemplate",
}

Instance Attribute Summary collapse

Instance Attribute Details

#api_idString

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

Returns:

  • (String)


313
314
315
316
317
318
319
320
321
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 313

class CreateResolverRequest < Struct.new(
  :api_id,
  :type_name,
  :field_name,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template)
  include Aws::Structure
end

#data_source_nameString

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

Returns:

  • (String)


313
314
315
316
317
318
319
320
321
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 313

class CreateResolverRequest < Struct.new(
  :api_id,
  :type_name,
  :field_name,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template)
  include Aws::Structure
end

#field_nameString

The name of the field to attach the resolver to.

Returns:

  • (String)


313
314
315
316
317
318
319
320
321
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 313

class CreateResolverRequest < Struct.new(
  :api_id,
  :type_name,
  :field_name,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template)
  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)


313
314
315
316
317
318
319
320
321
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 313

class CreateResolverRequest < Struct.new(
  :api_id,
  :type_name,
  :field_name,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template)
  include Aws::Structure
end

#response_mapping_templateString

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

Returns:

  • (String)


313
314
315
316
317
318
319
320
321
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 313

class CreateResolverRequest < Struct.new(
  :api_id,
  :type_name,
  :field_name,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template)
  include Aws::Structure
end

#type_nameString

The name of the Type.

Returns:

  • (String)


313
314
315
316
317
318
319
320
321
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 313

class CreateResolverRequest < Struct.new(
  :api_id,
  :type_name,
  :field_name,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template)
  include Aws::Structure
end