BaseAppsyncFunctionProps

class aws_cdk.aws_appsync.BaseAppsyncFunctionProps(*, name, code=None, description=None, max_batch_size=None, request_mapping_template=None, response_mapping_template=None, runtime=None)

Bases: object

the base properties for AppSync Functions.

Parameters:

  • name (str) – the name of the AppSync Function.

  • code (Optional[Code]) – The function code. Default: - no code is used

  • description (Optional[str]) – the description for this AppSync Function. Default: - no description

  • max_batch_size (Union[int, float, None]) – The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation. Can only be set when using LambdaDataSource. Default: - No max batch size

  • request_mapping_template (Optional[MappingTemplate]) – the request mapping template for the AppSync Function. Default: - no request mapping template

  • response_mapping_template (Optional[MappingTemplate]) – the response mapping template for the AppSync Function. Default: - no response mapping template

  • runtime (Optional[FunctionRuntime]) – The functions runtime. Default: - no function runtime, VTL mapping templates used

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appsync as appsync

# code: appsync.Code
# function_runtime: appsync.FunctionRuntime
# mapping_template: appsync.MappingTemplate

base_appsync_function_props = appsync.BaseAppsyncFunctionProps(
    name="name",

    # the properties below are optional
    code=code,
    description="description",
    max_batch_size=123,
    request_mapping_template=mapping_template,
    response_mapping_template=mapping_template,
    runtime=function_runtime
)

Attributes

code

The function code.

Default:

  • no code is used

description

the description for this AppSync Function.

Default:

  • no description

max_batch_size

The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.

Can only be set when using LambdaDataSource.

Default:

  • No max batch size

name

the name of the AppSync Function.

request_mapping_template

the request mapping template for the AppSync Function.

Default:

  • no request mapping template

response_mapping_template

the response mapping template for the AppSync Function.

Default:

  • no response mapping template

runtime

The functions runtime.

Default:

  • no function runtime, VTL mapping templates used