Interface IBaseAppsyncFunctionProps

the base properties for AppSync Functions.

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IBaseAppsyncFunctionProps

Syntax (vb)

Public Interface IBaseAppsyncFunctionProps

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.AppSync;

            Code code;
            FunctionRuntime functionRuntime;
            MappingTemplate mappingTemplate;

            var baseAppsyncFunctionProps = new BaseAppsyncFunctionProps {
                Name = "name",

                // the properties below are optional
                Code = code,
                Description = "description",
                MaxBatchSize = 123,
                RequestMappingTemplate = mappingTemplate,
                ResponseMappingTemplate = mappingTemplate,
                Runtime = functionRuntime
            };

Synopsis

Properties

Code	The function code.
Description	the description for this AppSync Function.
MaxBatchSize	The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.
Name	the name of the AppSync Function.
RequestMappingTemplate	the request mapping template for the AppSync Function.
ResponseMappingTemplate	the response mapping template for the AppSync Function.
Runtime	The functions runtime.

Properties

Code

The function code.

Code? Code { get; }

Property Value

Code

Remarks

Default: - no code is used

Description

the description for this AppSync Function.

string? Description { get; }

Property Value

string

Remarks

Default: - no description

MaxBatchSize

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

double? MaxBatchSize { get; }

Property Value

double?

Remarks

Can only be set when using LambdaDataSource.

Default: - No max batch size

Name

the name of the AppSync Function.

string Name { get; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

RequestMappingTemplate

the request mapping template for the AppSync Function.

MappingTemplate? RequestMappingTemplate { get; }

Property Value

MappingTemplate

Remarks

Default: - no request mapping template

ResponseMappingTemplate

the response mapping template for the AppSync Function.

MappingTemplate? ResponseMappingTemplate { get; }

Property Value

MappingTemplate

Remarks

Default: - no response mapping template

Runtime

The functions runtime.

FunctionRuntime? Runtime { get; }

Property Value

FunctionRuntime

Remarks

Default: - no function runtime, VTL mapping templates used