Class: Aws::AppSync::Types::FunctionConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::AppSync::Types::FunctionConfiguration

Defined in:

gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb

Overview

A function is a reusable entity. You can use multiple functions to compose the resolver logic.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #code ⇒ String

  The function code that contains the request and response functions.

• #data_source_name ⇒ String

  The name of the DataSource.

• #description ⇒ String

  The Function description.

• #function_arn ⇒ String

  The Amazon Resource Name (ARN) of the Function object.

• #function_id ⇒ String

  A unique ID representing the Function object.

• #function_version ⇒ String

  The version of the request mapping template.

• #max_batch_size ⇒ Integer

  The maximum batching size for a resolver.

• #name ⇒ String

  The name of the Function object.

• #request_mapping_template ⇒ String

  The Function request mapping template.

• #response_mapping_template ⇒ String

  The Function response mapping template.

• #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

  Describes a Sync configuration for a resolver.

Instance Attribute Details

#code ⇒ String

The function 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 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2354

class FunctionConfiguration < Struct.new(
  :function_id,
  :function_arn,
  :name,
  :description,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :function_version,
  :sync_config,
  :max_batch_size,
  :runtime,
  :code)
  SENSITIVE = []
  include Aws::Structure
end

#data_source_name ⇒ String

The name of the DataSource.

Returns:

• (String)

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

class FunctionConfiguration < Struct.new(
  :function_id,
  :function_arn,
  :name,
  :description,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :function_version,
  :sync_config,
  :max_batch_size,
  :runtime,
  :code)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The Function description.

Returns:

• (String)

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

class FunctionConfiguration < Struct.new(
  :function_id,
  :function_arn,
  :name,
  :description,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :function_version,
  :sync_config,
  :max_batch_size,
  :runtime,
  :code)
  SENSITIVE = []
  include Aws::Structure
end

#function_arn ⇒ String

The Amazon Resource Name (ARN) of the Function object.

Returns:

• (String)

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

class FunctionConfiguration < Struct.new(
  :function_id,
  :function_arn,
  :name,
  :description,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :function_version,
  :sync_config,
  :max_batch_size,
  :runtime,
  :code)
  SENSITIVE = []
  include Aws::Structure
end

#function_id ⇒ String

A unique ID representing the Function object.

Returns:

• (String)

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

class FunctionConfiguration < Struct.new(
  :function_id,
  :function_arn,
  :name,
  :description,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :function_version,
  :sync_config,
  :max_batch_size,
  :runtime,
  :code)
  SENSITIVE = []
  include Aws::Structure
end

#function_version ⇒ String

The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.

Returns:

• (String)

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

class FunctionConfiguration < Struct.new(
  :function_id,
  :function_arn,
  :name,
  :description,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :function_version,
  :sync_config,
  :max_batch_size,
  :runtime,
  :code)
  SENSITIVE = []
  include Aws::Structure
end

#max_batch_size ⇒ Integer

The maximum batching size for a resolver.

Returns:

• (Integer)

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

class FunctionConfiguration < Struct.new(
  :function_id,
  :function_arn,
  :name,
  :description,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :function_version,
  :sync_config,
  :max_batch_size,
  :runtime,
  :code)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the Function object.

Returns:

• (String)

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

class FunctionConfiguration < Struct.new(
  :function_id,
  :function_arn,
  :name,
  :description,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :function_version,
  :sync_config,
  :max_batch_size,
  :runtime,
  :code)
  SENSITIVE = []
  include Aws::Structure
end

#request_mapping_template ⇒ String

The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

Returns:

• (String)

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

class FunctionConfiguration < Struct.new(
  :function_id,
  :function_arn,
  :name,
  :description,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :function_version,
  :sync_config,
  :max_batch_size,
  :runtime,
  :code)
  SENSITIVE = []
  include Aws::Structure
end

#response_mapping_template ⇒ String

The Function response mapping template.

Returns:

• (String)

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

class FunctionConfiguration < Struct.new(
  :function_id,
  :function_arn,
  :name,
  :description,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :function_version,
  :sync_config,
  :max_batch_size,
  :runtime,
  :code)
  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 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2354

class FunctionConfiguration < Struct.new(
  :function_id,
  :function_arn,
  :name,
  :description,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :function_version,
  :sync_config,
  :max_batch_size,
  :runtime,
  :code)
  SENSITIVE = []
  include Aws::Structure
end

#sync_config ⇒ Types::SyncConfig

Describes a Sync configuration for a resolver.

Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.

Returns:

• (Types::SyncConfig)

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

class FunctionConfiguration < Struct.new(
  :function_id,
  :function_arn,
  :name,
  :description,
  :data_source_name,
  :request_mapping_template,
  :response_mapping_template,
  :function_version,
  :sync_config,
  :max_batch_size,
  :runtime,
  :code)
  SENSITIVE = []
  include Aws::Structure
end