software.amazon.awscdk.services.appsync

Interface CfnFunctionConfigurationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFunctionConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.677Z")
 @Stability(value=Stable)
public interface CfnFunctionConfigurationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnFunctionConfiguration`.

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.*;
 CfnFunctionConfigurationProps cfnFunctionConfigurationProps = CfnFunctionConfigurationProps.builder()
         .apiId("apiId")
         .dataSourceName("dataSourceName")
         .functionVersion("functionVersion")
         .name("name")
         // the properties below are optional
         .description("description")
         .maxBatchSize(123)
         .requestMappingTemplate("requestMappingTemplate")
         .requestMappingTemplateS3Location("requestMappingTemplateS3Location")
         .responseMappingTemplate("responseMappingTemplate")
         .responseMappingTemplateS3Location("responseMappingTemplateS3Location")
         .syncConfig(SyncConfigProperty.builder()
                 .conflictDetection("conflictDetection")
                 // the properties below are optional
                 .conflictHandler("conflictHandler")
                 .lambdaConflictHandlerConfig(LambdaConflictHandlerConfigProperty.builder()
                         .lambdaConflictHandlerArn("lambdaConflictHandlerArn")
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnFunctionConfigurationProps.Builder	builder()
String	getApiId() The AWS AppSync GraphQL API that you want to attach using this function.
String	getDataSourceName() The name of data source this function will attach.
default String	getDescription() The `Function` description.
String	getFunctionVersion() The version of the request mapping template.
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 function.
default String	getRequestMappingTemplate() The `Function` request mapping template.
default String	getRequestMappingTemplateS3Location() Describes a Sync configuration for a resolver.
default String	getResponseMappingTemplate() The `Function` response mapping template.
default String	getResponseMappingTemplateS3Location() The location of a response mapping template in an Amazon S3 bucket.
default Object	getSyncConfig() Describes a Sync configuration for a resolver.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApiId

@Stability(value=Stable)
 @NotNull
String getApiId()

The AWS AppSync GraphQL API that you want to attach using this function.

getDataSourceName

@Stability(value=Stable)
 @NotNull
String getDataSourceName()

The name of data source this function will attach.

getFunctionVersion

@Stability(value=Stable)
 @NotNull
String getFunctionVersion()

The version of the request mapping template.

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

getName

@Stability(value=Stable)
 @NotNull
String getName()

The name of the function.

getDescription

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

The `Function` description.

getMaxBatchSize

@Stability(value=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.

getRequestMappingTemplate

@Stability(value=Stable)
 @Nullable
default String getRequestMappingTemplate()

The `Function` request mapping template.

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

getRequestMappingTemplateS3Location

@Stability(value=Stable)
 @Nullable
default String getRequestMappingTemplateS3Location()

Describes a Sync configuration for a resolver.

Contains information on which Conflict Detection, as well as Resolution strategy, should be performed when the resolver is invoked.

getResponseMappingTemplate

@Stability(value=Stable)
 @Nullable
default String getResponseMappingTemplate()

The `Function` response mapping template.

getResponseMappingTemplateS3Location

@Stability(value=Stable)
 @Nullable
default String getResponseMappingTemplateS3Location()

The location of a response mapping template in an Amazon S3 bucket.

Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.

getSyncConfig

@Stability(value=Stable)
 @Nullable
default Object getSyncConfig()

Describes a Sync configuration for a resolver.

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

builder

@Stability(value=Stable)
static CfnFunctionConfigurationProps.Builder builder()

Returns:

a CfnFunctionConfigurationProps.Builder of CfnFunctionConfigurationProps