Package software.amazon.awscdk.services.appsync

Class CfnFunctionConfiguration.Builder

java.lang.Object

software.amazon.awscdk.services.appsync.CfnFunctionConfiguration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFunctionConfiguration>

Enclosing class:

CfnFunctionConfiguration

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

A fluent builder for CfnFunctionConfiguration.

Method Summary

Modifier and Type	Method	Description
CfnFunctionConfiguration.Builder	apiId(String apiId)	The AWS AppSync GraphQL API that you want to attach using this function.
CfnFunctionConfiguration	build()
CfnFunctionConfiguration.Builder	code(String code)	The resolver code that contains the request and response functions.
CfnFunctionConfiguration.Builder	codeS3Location(String codeS3Location)	The Amazon S3 endpoint.
static CfnFunctionConfiguration.Builder	create(software.constructs.Construct scope, String id)
CfnFunctionConfiguration.Builder	dataSourceName(String dataSourceName)	The name of data source this function will attach.
CfnFunctionConfiguration.Builder	description(String description)	The Function description.
CfnFunctionConfiguration.Builder	functionVersion(String functionVersion)	The version of the request mapping template.
CfnFunctionConfiguration.Builder	maxBatchSize(Number maxBatchSize)	The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.
CfnFunctionConfiguration.Builder	name(String name)	The name of the function.
CfnFunctionConfiguration.Builder	requestMappingTemplate(String requestMappingTemplate)	The Function request mapping template.
CfnFunctionConfiguration.Builder	requestMappingTemplateS3Location(String requestMappingTemplateS3Location)	Describes a Sync configuration for a resolver.
CfnFunctionConfiguration.Builder	responseMappingTemplate(String responseMappingTemplate)	The Function response mapping template.
CfnFunctionConfiguration.Builder	responseMappingTemplateS3Location(String responseMappingTemplateS3Location)	The location of a response mapping template in an Amazon S3 bucket.
CfnFunctionConfiguration.Builder	runtime(IResolvable runtime)	Describes a runtime used by an AWS AppSync resolver or AWS AppSync function.
CfnFunctionConfiguration.Builder	runtime(CfnFunctionConfiguration.AppSyncRuntimeProperty runtime)	Describes a runtime used by an AWS AppSync resolver or AWS AppSync function.
CfnFunctionConfiguration.Builder	syncConfig(IResolvable syncConfig)	Describes a Sync configuration for a resolver.
CfnFunctionConfiguration.Builder	syncConfig(CfnFunctionConfiguration.SyncConfigProperty syncConfig)	Describes a Sync configuration for a resolver.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnFunctionConfiguration.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnFunctionConfiguration.Builder.

apiId

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

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

Parameters:

apiId - The AWS AppSync GraphQL API that you want to attach using this function. This parameter is required.

Returns:

this

See Also:

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

dataSourceName

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

The name of data source this function will attach.

Parameters:

dataSourceName - The name of data source this function will attach. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnFunctionConfiguration.Builder name(String name)

The name of the function.

Parameters:

name - The name of the function. This parameter is required.

Returns:

this

See Also:

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

code

@Stability(Stable)
public CfnFunctionConfiguration.Builder code(String 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 .

Parameters:

code - The resolver code that contains the request and response functions. This parameter is required.

Returns:

this

See Also:

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

codeS3Location

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

The Amazon S3 endpoint.

Parameters:

codeS3Location - The Amazon S3 endpoint. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnFunctionConfiguration.Builder description(String description)

The Function description.

Parameters:

description - The Function description. This parameter is required.

Returns:

this

See Also:

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

functionVersion

@Stability(Stable)
public CfnFunctionConfiguration.Builder functionVersion(String functionVersion)

The version of the request mapping template.

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

Parameters:

functionVersion - The version of the request mapping template. This parameter is required.

Returns:

this

See Also:

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

maxBatchSize

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

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

Parameters:

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

Returns:

this

See Also:

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

requestMappingTemplate

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

The Function request mapping template.

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

Parameters:

requestMappingTemplate - The Function request mapping template. This parameter is required.

Returns:

this

See Also:

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

requestMappingTemplateS3Location

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

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.

Parameters:

requestMappingTemplateS3Location - Describes a Sync configuration for a resolver. This parameter is required.

Returns:

this

See Also:

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

responseMappingTemplate

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

The Function response mapping template.

Parameters:

responseMappingTemplate - The Function response mapping template. This parameter is required.

Returns:

this

See Also:

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

responseMappingTemplateS3Location

@Stability(Stable)
public CfnFunctionConfiguration.Builder responseMappingTemplateS3Location(String 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.

Parameters:

responseMappingTemplateS3Location - The location of a response mapping template in an Amazon S3 bucket. This parameter is required.

Returns:

this

See Also:

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

runtime

@Stability(Stable)
public CfnFunctionConfiguration.Builder runtime(IResolvable 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.

Parameters:

runtime - Describes a runtime used by an AWS AppSync resolver or AWS AppSync function. This parameter is required.

Returns:

this

See Also:

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

runtime

@Stability(Stable)
public CfnFunctionConfiguration.Builder runtime(CfnFunctionConfiguration.AppSyncRuntimeProperty 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.

Parameters:

runtime - Describes a runtime used by an AWS AppSync resolver or AWS AppSync function. This parameter is required.

Returns:

this

See Also:

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

syncConfig

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

Describes a Sync configuration for a resolver.

Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.

Parameters:

syncConfig - Describes a Sync configuration for a resolver. This parameter is required.

Returns:

this

See Also:

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

syncConfig

@Stability(Stable)
public CfnFunctionConfiguration.Builder syncConfig(CfnFunctionConfiguration.SyncConfigProperty syncConfig)

Describes a Sync configuration for a resolver.

Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.

Parameters:

syncConfig - Describes a Sync configuration for a resolver. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnFunctionConfiguration build()

Specified by:

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

Returns:

a newly built instance of CfnFunctionConfiguration.