aws-cdk-lib.aws_appsync.BaseAppsyncFunctionProps

interface BaseAppsyncFunctionProps

LanguageType name
.NETAmazon.CDK.AWS.AppSync.BaseAppsyncFunctionProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappsync#BaseAppsyncFunctionProps
Javasoftware.amazon.awscdk.services.appsync.BaseAppsyncFunctionProps
Pythonaws_cdk.aws_appsync.BaseAppsyncFunctionProps
TypeScript (source)aws-cdk-lib » aws_appsync » BaseAppsyncFunctionProps

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 { aws_appsync as appsync } from 'aws-cdk-lib';

declare const code: appsync.Code;
declare const functionRuntime: appsync.FunctionRuntime;
declare const mappingTemplate: appsync.MappingTemplate;
const baseAppsyncFunctionProps: appsync.BaseAppsyncFunctionProps = {
  name: 'name',

  // the properties below are optional
  code: code,
  description: 'description',
  requestMappingTemplate: mappingTemplate,
  responseMappingTemplate: mappingTemplate,
  runtime: functionRuntime,
};

Properties

NameTypeDescription
namestringthe name of the AppSync Function.
code?CodeThe function code.
description?stringthe description for this AppSync Function.
requestMappingTemplate?MappingTemplatethe request mapping template for the AppSync Function.
responseMappingTemplate?MappingTemplatethe response mapping template for the AppSync Function.
runtime?FunctionRuntimeThe functions runtime.

name

Type: string

the name of the AppSync Function.


code?

Type: Code (optional, default: no code is used)

The function code.


description?

Type: string (optional, default: no description)

the description for this AppSync Function.


requestMappingTemplate?

Type: MappingTemplate (optional, default: no request mapping template)

the request mapping template for the AppSync Function.


responseMappingTemplate?

Type: MappingTemplate (optional, default: no response mapping template)

the response mapping template for the AppSync Function.


runtime?

Type: FunctionRuntime (optional, default: no function runtime, VTL mapping templates used)

The functions runtime.