Package software.amazon.awscdk.services.appsync

Interface BaseAppsyncFunctionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AppsyncFunctionProps

All Known Implementing Classes:

AppsyncFunctionProps.Jsii$Proxy, BaseAppsyncFunctionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:14.571Z")
@Stability(Stable)
public interface BaseAppsyncFunctionProps
extends software.amazon.jsii.JsiiSerializable

the base properties for AppSync Functions.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appsync.*;
 Code code;
 FunctionRuntime functionRuntime;
 MappingTemplate mappingTemplate;
 BaseAppsyncFunctionProps baseAppsyncFunctionProps = BaseAppsyncFunctionProps.builder()
         .name("name")
         // the properties below are optional
         .code(code)
         .description("description")
         .maxBatchSize(123)
         .requestMappingTemplate(mappingTemplate)
         .responseMappingTemplate(mappingTemplate)
         .runtime(functionRuntime)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	BaseAppsyncFunctionProps.Builder	A builder for BaseAppsyncFunctionProps
static final class	BaseAppsyncFunctionProps.Jsii$Proxy	An implementation for BaseAppsyncFunctionProps

Method Summary

Modifier and Type	Method	Description
static BaseAppsyncFunctionProps.Builder	builder()
default Code	getCode()	The function code.
default String	getDescription()	the description for this AppSync Function.
default Number	getMaxBatchSize()	The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.
String	getName()	the name of the AppSync Function.
default MappingTemplate	getRequestMappingTemplate()	the request mapping template for the AppSync Function.
default MappingTemplate	getResponseMappingTemplate()	the response mapping template for the AppSync Function.
default FunctionRuntime	getRuntime()	The functions runtime.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

the name of the AppSync Function.

getCode

@Stability(Stable)
@Nullable
default Code getCode()

The function code.

Default: - no code is used

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

the description for this AppSync Function.

Default: - no description

getMaxBatchSize

@Stability(Stable)
@Nullable
default Number getMaxBatchSize()

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

getRequestMappingTemplate

@Stability(Stable)
@Nullable
default MappingTemplate getRequestMappingTemplate()

the request mapping template for the AppSync Function.

Default: - no request mapping template

getResponseMappingTemplate

@Stability(Stable)
@Nullable
default MappingTemplate getResponseMappingTemplate()

the response mapping template for the AppSync Function.

Default: - no response mapping template

getRuntime

@Stability(Stable)
@Nullable
default FunctionRuntime getRuntime()

The functions runtime.

Default: - no function runtime, VTL mapping templates used

builder

@Stability(Stable)
static BaseAppsyncFunctionProps.Builder builder()

Returns:

a BaseAppsyncFunctionProps.Builder of BaseAppsyncFunctionProps