Package 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.104.0 (build e79254c)",
           date="2024-11-22T02:23:57.129Z")
@Stability(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")
         .name("name")
         // the properties below are optional
         .code("code")
         .codeS3Location("codeS3Location")
         .description("description")
         .functionVersion("functionVersion")
         .maxBatchSize(123)
         .requestMappingTemplate("requestMappingTemplate")
         .requestMappingTemplateS3Location("requestMappingTemplateS3Location")
         .responseMappingTemplate("responseMappingTemplate")
         .responseMappingTemplateS3Location("responseMappingTemplateS3Location")
         .runtime(AppSyncRuntimeProperty.builder()
                 .name("name")
                 .runtimeVersion("runtimeVersion")
                 .build())
         .syncConfig(SyncConfigProperty.builder()
                 .conflictDetection("conflictDetection")
                 // the properties below are optional
                 .conflictHandler("conflictHandler")
                 .lambdaConflictHandlerConfig(LambdaConflictHandlerConfigProperty.builder()
                         .lambdaConflictHandlerArn("lambdaConflictHandlerArn")
                         .build())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFunctionConfigurationProps.Builder	builder()
String	getApiId()	The AWS AppSync GraphQL API that you want to attach using this function.
default String	getCode()	The resolver code that contains the request and response functions.
default String	getCodeS3Location()	The Amazon S3 endpoint.
String	getDataSourceName()	The name of data source this function will attach.
default String	getDescription()	The Function description.
default 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	getRuntime()	Describes a runtime used by an AWS AppSync resolver or AWS AppSync function.
default Object	getSyncConfig()	Describes a Sync configuration for a resolver.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiId

@Stability(Stable)
@NotNull
String getApiId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-apiid

getDataSourceName

@Stability(Stable)
@NotNull
String getDataSourceName()

The name of data source this function will attach.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-datasourcename

getName

@Stability(Stable)
@NotNull
String getName()

The name of the function.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-name

getCode

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

The resolver code that contains the request and response functions.

When code is used, the runtime is required. The runtime value must be APPSYNC_JS .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-code

getCodeS3Location

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

The Amazon S3 endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-codes3location

getDescription

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

The Function description.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-description

getFunctionVersion

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

The version of the request mapping template.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-functionversion

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-maxbatchsize

getRequestMappingTemplate

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

The Function request mapping template.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-requestmappingtemplate

getRequestMappingTemplateS3Location

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-requestmappingtemplates3location

getResponseMappingTemplate

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

The Function response mapping template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-responsemappingtemplate

getResponseMappingTemplateS3Location

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-responsemappingtemplates3location

getRuntime

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

Describes a runtime used by an AWS AppSync resolver or AWS AppSync function.

Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-runtime

getSyncConfig

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html#cfn-appsync-functionconfiguration-syncconfig

builder

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

Returns:

a CfnFunctionConfigurationProps.Builder of CfnFunctionConfigurationProps