Package 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.104.0 (build e79254c)",
           date="2024-12-17T21:37:26.466Z")
@Stability(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())
         .code("code")
         .codeS3Location("codeS3Location")
         .dataSourceName("dataSourceName")
         .kind("kind")
         .maxBatchSize(123)
         .metricsConfig("metricsConfig")
         .pipelineConfig(PipelineConfigProperty.builder()
                 .functions(List.of("functions"))
                 .build())
         .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-resolver.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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	getCode()	The resolver code that contains the request and response functions.
default String	getCodeS3Location()	The Amazon S3 endpoint.
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 String	getMetricsConfig()	Enables or disables enhanced resolver metrics for specified resolvers.
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	getRuntime()	Describes a runtime used by an AWS AppSync resolver or AWS AppSync function.
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 Details

getApiId

@Stability(Stable)
@NotNull
String getApiId()

The AWS AppSync GraphQL API to which you want to attach this resolver.

See Also:

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

getFieldName

@Stability(Stable)
@NotNull
String getFieldName()

The GraphQL field on a type that invokes the resolver.

See Also:

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

getTypeName

@Stability(Stable)
@NotNull
String getTypeName()

The GraphQL type that invokes this resolver.

See Also:

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

getCachingConfig

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

The caching configuration for the resolver.

See Also:

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

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-resolver.html#cfn-appsync-resolver-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-resolver.html#cfn-appsync-resolver-codes3location

getDataSourceName

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

The resolver data source name.

See Also:

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

getKind

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

See Also:

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

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-resolver.html#cfn-appsync-resolver-maxbatchsize

getMetricsConfig

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

Enables or disables enhanced resolver metrics for specified resolvers.

Note that MetricsConfig won't be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS . If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead, MetricsConfig will be ignored. However, you can still set its value.

See Also:

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

getPipelineConfig

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

Functions linked with the pipeline resolver.

See Also:

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

getRequestMappingTemplate

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

See Also:

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

getRequestMappingTemplateS3Location

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

See Also:

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

getResponseMappingTemplate

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

The response mapping template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#cfn-appsync-resolver-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-resolver.html#cfn-appsync-resolver-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-resolver.html#cfn-appsync-resolver-runtime

getSyncConfig

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

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

See Also:

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

builder

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

Returns:

a CfnResolverProps.Builder of CfnResolverProps