software.amazon.awscdk.services.appsync

Interface CfnResolverProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnResolverProps.Jsii$Proxy

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

Properties for defining a `CfnResolver`.

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.*;
 CfnResolverProps cfnResolverProps = CfnResolverProps.builder()
         .apiId("apiId")
         .fieldName("fieldName")
         .typeName("typeName")
         // the properties below are optional
         .cachingConfig(CachingConfigProperty.builder()
                 .ttl(123)
                 // the properties below are optional
                 .cachingKeys(List.of("cachingKeys"))
                 .build())
         .dataSourceName("dataSourceName")
         .kind("kind")
         .maxBatchSize(123)
         .pipelineConfig(PipelineConfigProperty.builder()
                 .functions(List.of("functions"))
                 .build())
         .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	CfnResolverProps.Builder A builder for CfnResolverProps
static class	CfnResolverProps.Jsii$Proxy An implementation for CfnResolverProps

Method Summary

Modifier and Type	Method and Description
static CfnResolverProps.Builder	builder()
String	getApiId() The AWS AppSync GraphQL API to which you want to attach this resolver.
default Object	getCachingConfig() The caching configuration for the resolver.
default String	getDataSourceName() The resolver data source name.
String	getFieldName() The GraphQL field on a type that invokes the resolver.
default String	getKind() The resolver type.
default Number	getMaxBatchSize() The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a `BatchInvoke` operation.
default Object	getPipelineConfig() Functions linked with the pipeline resolver.
default String	getRequestMappingTemplate() The request mapping template.
default String	getRequestMappingTemplateS3Location() The location of a request mapping template in an Amazon S3 bucket.
default String	getResponseMappingTemplate() The response mapping template.
default String	getResponseMappingTemplateS3Location() The location of a response mapping template in an Amazon S3 bucket.
default Object	getSyncConfig() The `SyncConfig` for a resolver attached to a versioned data source.
String	getTypeName() The GraphQL type that invokes this 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 to which you want to attach this resolver.

getFieldName

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

The GraphQL field on a type that invokes the resolver.

getTypeName

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

The GraphQL type that invokes this resolver.

getCachingConfig

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

The caching configuration for the resolver.

getDataSourceName

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

The resolver data source name.

getKind

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

The resolver type.

• UNIT : A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
• PIPELINE : A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.

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.

getPipelineConfig

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

Functions linked with the pipeline resolver.

getRequestMappingTemplate

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

The request mapping template.

Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.

getRequestMappingTemplateS3Location

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

The location of a request 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.

getResponseMappingTemplate

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

The 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()

The `SyncConfig` for a resolver attached to a versioned data source.

builder

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

Returns:

a CfnResolverProps.Builder of CfnResolverProps