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

Inherits:
Struct
  • Object
show all
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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#codeString

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)


2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2762

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_nameString

The name of the DataSource.

Returns:

  • (String)


2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2762

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

#descriptionString

The Function description.

Returns:

  • (String)


2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2762

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_arnString

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

Returns:

  • (String)


2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2762

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_idString

A unique ID representing the Function object.

Returns:

  • (String)


2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2762

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_versionString

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

Returns:

  • (String)


2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2762

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_sizeInteger

The maximum batching size for a resolver.

Returns:

  • (Integer)


2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2762

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

#nameString

The name of the Function object.

Returns:

  • (String)


2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2762

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_templateString

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

Returns:

  • (String)


2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2762

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_templateString

The Function response mapping template.

Returns:

  • (String)


2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2762

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

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



2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2762

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_configTypes::SyncConfig

Describes a Sync configuration for a resolver.

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

Returns:



2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2762

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