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.84.0 (build 5404dcf)", date="2023-06-19T16:30:49.432Z") @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();

  • Method Details

    • getApiId

      @Stability(Stable) @NotNull String getApiId()
      The AWS AppSync GraphQL API that you want to attach using this function.

    • getDataSourceName

      @Stability(Stable) @NotNull String getDataSourceName()
      The name of data source this function will attach.

    • getName

      @Stability(Stable) @NotNull String getName()
      The name of the function.

    • 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 .

    • getCodeS3Location

      @Stability(Stable) @Nullable default String getCodeS3Location()
      The Amazon S3 endpoint.

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      The Function 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.

    • 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.

    • 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.

    • 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.

    • getResponseMappingTemplate

      @Stability(Stable) @Nullable default String getResponseMappingTemplate()
      The Function response mapping template.

    • 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.

    • getRuntime

      @Stability(Stable) @Nullable default Object getRuntime()
      Describes a runtime used by an AWS AppSync pipeline 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.

    • 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.

    • builder

      @Stability(Stable) static CfnFunctionConfigurationProps.Builder builder()
      Returns:
      a CfnFunctionConfigurationProps.Builder of CfnFunctionConfigurationProps