Package software.amazon.awscdk.services.appsync

Class CfnResolverProps.Builder

java.lang.Object

software.amazon.awscdk.services.appsync.CfnResolverProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnResolverProps>

Enclosing interface:

CfnResolverProps

@Stability(Stable)
public static final class CfnResolverProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnResolverProps>

A builder for CfnResolverProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnResolverProps.Builder	apiId(String apiId)	Sets the value of CfnResolverProps.getApiId()
CfnResolverProps	build()	Builds the configured instance.
CfnResolverProps.Builder	cachingConfig(IResolvable cachingConfig)	Sets the value of CfnResolverProps.getCachingConfig()
CfnResolverProps.Builder	cachingConfig(CfnResolver.CachingConfigProperty cachingConfig)	Sets the value of CfnResolverProps.getCachingConfig()
CfnResolverProps.Builder	code(String code)	Sets the value of CfnResolverProps.getCode()
CfnResolverProps.Builder	codeS3Location(String codeS3Location)	Sets the value of CfnResolverProps.getCodeS3Location()
CfnResolverProps.Builder	dataSourceName(String dataSourceName)	Sets the value of CfnResolverProps.getDataSourceName()
CfnResolverProps.Builder	fieldName(String fieldName)	Sets the value of CfnResolverProps.getFieldName()
CfnResolverProps.Builder	kind(String kind)	Sets the value of CfnResolverProps.getKind()
CfnResolverProps.Builder	maxBatchSize(Number maxBatchSize)	Sets the value of CfnResolverProps.getMaxBatchSize()
CfnResolverProps.Builder	metricsConfig(String metricsConfig)	Sets the value of CfnResolverProps.getMetricsConfig()
CfnResolverProps.Builder	pipelineConfig(IResolvable pipelineConfig)	Sets the value of CfnResolverProps.getPipelineConfig()
CfnResolverProps.Builder	pipelineConfig(CfnResolver.PipelineConfigProperty pipelineConfig)	Sets the value of CfnResolverProps.getPipelineConfig()
CfnResolverProps.Builder	requestMappingTemplate(String requestMappingTemplate)	Sets the value of CfnResolverProps.getRequestMappingTemplate()
CfnResolverProps.Builder	requestMappingTemplateS3Location(String requestMappingTemplateS3Location)	Sets the value of CfnResolverProps.getRequestMappingTemplateS3Location()
CfnResolverProps.Builder	responseMappingTemplate(String responseMappingTemplate)	Sets the value of CfnResolverProps.getResponseMappingTemplate()
CfnResolverProps.Builder	responseMappingTemplateS3Location(String responseMappingTemplateS3Location)	Sets the value of CfnResolverProps.getResponseMappingTemplateS3Location()
CfnResolverProps.Builder	runtime(IResolvable runtime)	Sets the value of CfnResolverProps.getRuntime()
CfnResolverProps.Builder	runtime(CfnResolver.AppSyncRuntimeProperty runtime)	Sets the value of CfnResolverProps.getRuntime()
CfnResolverProps.Builder	syncConfig(IResolvable syncConfig)	Sets the value of CfnResolverProps.getSyncConfig()
CfnResolverProps.Builder	syncConfig(CfnResolver.SyncConfigProperty syncConfig)	Sets the value of CfnResolverProps.getSyncConfig()
CfnResolverProps.Builder	typeName(String typeName)	Sets the value of CfnResolverProps.getTypeName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

apiId

@Stability(Stable)
public CfnResolverProps.Builder apiId(String apiId)

Sets the value of CfnResolverProps.getApiId()

Parameters:

apiId - The AWS AppSync GraphQL API to which you want to attach this resolver. This parameter is required.

Returns:

this

fieldName

@Stability(Stable)
public CfnResolverProps.Builder fieldName(String fieldName)

Sets the value of CfnResolverProps.getFieldName()

Parameters:

fieldName - The GraphQL field on a type that invokes the resolver. This parameter is required.

Returns:

this

typeName

@Stability(Stable)
public CfnResolverProps.Builder typeName(String typeName)

Sets the value of CfnResolverProps.getTypeName()

Parameters:

typeName - The GraphQL type that invokes this resolver. This parameter is required.

Returns:

this

cachingConfig

@Stability(Stable)
public CfnResolverProps.Builder cachingConfig(IResolvable cachingConfig)

Sets the value of CfnResolverProps.getCachingConfig()

Parameters:

cachingConfig - The caching configuration for the resolver.

Returns:

this

cachingConfig

@Stability(Stable)
public CfnResolverProps.Builder cachingConfig(CfnResolver.CachingConfigProperty cachingConfig)

Sets the value of CfnResolverProps.getCachingConfig()

Parameters:

cachingConfig - The caching configuration for the resolver.

Returns:

this

code

@Stability(Stable)
public CfnResolverProps.Builder code(String code)

Sets the value of CfnResolverProps.getCode()

Parameters:

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

Returns:

this

codeS3Location

@Stability(Stable)
public CfnResolverProps.Builder codeS3Location(String codeS3Location)

Sets the value of CfnResolverProps.getCodeS3Location()

Parameters:

codeS3Location - The Amazon S3 endpoint.

Returns:

this

dataSourceName

@Stability(Stable)
public CfnResolverProps.Builder dataSourceName(String dataSourceName)

Sets the value of CfnResolverProps.getDataSourceName()

Parameters:

dataSourceName - The resolver data source name.

Returns:

this

kind

@Stability(Stable)
public CfnResolverProps.Builder kind(String kind)

Sets the value of CfnResolverProps.getKind()

Parameters:

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

Returns:

this

maxBatchSize

@Stability(Stable)
public CfnResolverProps.Builder maxBatchSize(Number maxBatchSize)

Sets the value of CfnResolverProps.getMaxBatchSize()

Parameters:

maxBatchSize - The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.

Returns:

this

metricsConfig

@Stability(Stable)
public CfnResolverProps.Builder metricsConfig(String metricsConfig)

Sets the value of CfnResolverProps.getMetricsConfig()

Parameters:

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

Returns:

this

pipelineConfig

@Stability(Stable)
public CfnResolverProps.Builder pipelineConfig(IResolvable pipelineConfig)

Sets the value of CfnResolverProps.getPipelineConfig()

Parameters:

pipelineConfig - Functions linked with the pipeline resolver.

Returns:

this

pipelineConfig

@Stability(Stable)
public CfnResolverProps.Builder pipelineConfig(CfnResolver.PipelineConfigProperty pipelineConfig)

Sets the value of CfnResolverProps.getPipelineConfig()

Parameters:

pipelineConfig - Functions linked with the pipeline resolver.

Returns:

this

requestMappingTemplate

@Stability(Stable)
public CfnResolverProps.Builder requestMappingTemplate(String requestMappingTemplate)

Sets the value of CfnResolverProps.getRequestMappingTemplate()

Parameters:

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

Returns:

this

requestMappingTemplateS3Location

@Stability(Stable)
public CfnResolverProps.Builder requestMappingTemplateS3Location(String requestMappingTemplateS3Location)

Sets the value of CfnResolverProps.getRequestMappingTemplateS3Location()

Parameters:

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

Returns:

this

responseMappingTemplate

@Stability(Stable)
public CfnResolverProps.Builder responseMappingTemplate(String responseMappingTemplate)

Sets the value of CfnResolverProps.getResponseMappingTemplate()

Parameters:

responseMappingTemplate - The response mapping template.

Returns:

this

responseMappingTemplateS3Location

@Stability(Stable)
public CfnResolverProps.Builder responseMappingTemplateS3Location(String responseMappingTemplateS3Location)

Sets the value of CfnResolverProps.getResponseMappingTemplateS3Location()

Parameters:

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

Returns:

this

runtime

@Stability(Stable)
public CfnResolverProps.Builder runtime(IResolvable runtime)

Sets the value of CfnResolverProps.getRuntime()

Parameters:

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

Returns:

this

runtime

@Stability(Stable)
public CfnResolverProps.Builder runtime(CfnResolver.AppSyncRuntimeProperty runtime)

Sets the value of CfnResolverProps.getRuntime()

Parameters:

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

Returns:

this

syncConfig

@Stability(Stable)
public CfnResolverProps.Builder syncConfig(IResolvable syncConfig)

Sets the value of CfnResolverProps.getSyncConfig()

Parameters:

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

Returns:

this

syncConfig

@Stability(Stable)
public CfnResolverProps.Builder syncConfig(CfnResolver.SyncConfigProperty syncConfig)

Sets the value of CfnResolverProps.getSyncConfig()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnResolverProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnResolverProps>

Returns:

a new instance of CfnResolverProps

Throws:

NullPointerException - if any required attribute was not provided