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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_idString

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

Returns:

  • (String)


1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
# File 'gems/aws-sdk-appsync/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_configTypes::CachingConfig

The caching configuration for the resolver.



1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
# File 'gems/aws-sdk-appsync/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

#codeString

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)


1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
# File 'gems/aws-sdk-appsync/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_nameString

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

Returns:

  • (String)


1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
# File 'gems/aws-sdk-appsync/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_nameString

The name of the field to attach the resolver to.

Returns:

  • (String)


1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
# File 'gems/aws-sdk-appsync/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

#kindString

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)


1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
# File 'gems/aws-sdk-appsync/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_sizeInteger

The maximum batching size for a resolver.

Returns:

  • (Integer)


1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
# File 'gems/aws-sdk-appsync/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_configString

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)


1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
# File 'gems/aws-sdk-appsync/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_configTypes::PipelineConfig

The PipelineConfig.



1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
# File 'gems/aws-sdk-appsync/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_templateString

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)


1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
# File 'gems/aws-sdk-appsync/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_templateString

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

Returns:

  • (String)


1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
# File 'gems/aws-sdk-appsync/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

#runtimeTypes::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.



1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
# File 'gems/aws-sdk-appsync/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_configTypes::SyncConfig

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

Returns:



1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
# File 'gems/aws-sdk-appsync/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_nameString

The name of the Type.

Returns:

  • (String)


1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
# File 'gems/aws-sdk-appsync/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