software.amazon.awscdk.services.appsync

Class CfnFunctionConfiguration

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.appsync.CfnFunctionConfiguration

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:30.727Z")
public class CfnFunctionConfiguration
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppSync::FunctionConfiguration`.

The AWS::AppSync::FunctionConfiguration resource defines the functions in GraphQL APIs to perform certain operations. You can use pipeline resolvers to attach functions. For more information, see Pipeline Resolvers in the AWS AppSync Developer Guide .

When you submit an update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the AWS CloudFormation template. Changing the Amazon S3 file content without changing a property value will not result in an update operation.

See Update Behaviors of Stack Resources in the AWS CloudFormation User Guide .

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.*;
 CfnFunctionConfiguration cfnFunctionConfiguration = CfnFunctionConfiguration.Builder.create(this, "MyCfnFunctionConfiguration")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnFunctionConfiguration.AppSyncRuntimeProperty Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function.
static class	CfnFunctionConfiguration.Builder A fluent builder for CfnFunctionConfiguration.
static interface	CfnFunctionConfiguration.LambdaConflictHandlerConfigProperty The `LambdaConflictHandlerConfig` object when configuring `LAMBDA` as the Conflict Handler.
static interface	CfnFunctionConfiguration.SyncConfigProperty Describes a Sync configuration for a resolver.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnFunctionConfiguration(Construct scope, java.lang.String id, CfnFunctionConfigurationProps props) Create a new `AWS::AppSync::FunctionConfiguration`.
protected	CfnFunctionConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFunctionConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApiId() The AWS AppSync GraphQL API that you want to attach using this function.
java.lang.String	getAttrDataSourceName() The name of data source this function will attach.
java.lang.String	getAttrFunctionArn() ARN of the function, such as `arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/functions/functionId` .
java.lang.String	getAttrFunctionId() The unique ID of this function.
java.lang.String	getAttrName() The name of the function.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getCode() The `resolver` code that contains the request and response functions.
java.lang.String	getCodeS3Location() The Amazon S3 endpoint.
java.lang.String	getDataSourceName() The name of data source this function will attach.
java.lang.String	getDescription() The `Function` description.
java.lang.String	getFunctionVersion() The version of the request mapping template.
java.lang.Number	getMaxBatchSize() The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a `BatchInvoke` operation.
java.lang.String	getName() The name of the function.
java.lang.String	getRequestMappingTemplate() The `Function` request mapping template.
java.lang.String	getRequestMappingTemplateS3Location() Describes a Sync configuration for a resolver.
java.lang.String	getResponseMappingTemplate() The `Function` response mapping template.
java.lang.String	getResponseMappingTemplateS3Location() The location of a response mapping template in an Amazon S3 bucket.
java.lang.Object	getRuntime() Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function.
java.lang.Object	getSyncConfig() Describes a Sync configuration for a resolver.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setApiId(java.lang.String value) The AWS AppSync GraphQL API that you want to attach using this function.
void	setCode(java.lang.String value) The `resolver` code that contains the request and response functions.
void	setCodeS3Location(java.lang.String value) The Amazon S3 endpoint.
void	setDataSourceName(java.lang.String value) The name of data source this function will attach.
void	setDescription(java.lang.String value) The `Function` description.
void	setFunctionVersion(java.lang.String value) The version of the request mapping template.
void	setMaxBatchSize(java.lang.Number value) The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a `BatchInvoke` operation.
void	setName(java.lang.String value) The name of the function.
void	setRequestMappingTemplate(java.lang.String value) The `Function` request mapping template.
void	setRequestMappingTemplateS3Location(java.lang.String value) Describes a Sync configuration for a resolver.
void	setResponseMappingTemplate(java.lang.String value) The `Function` response mapping template.
void	setResponseMappingTemplateS3Location(java.lang.String value) The location of a response mapping template in an Amazon S3 bucket.
void	setRuntime(CfnFunctionConfiguration.AppSyncRuntimeProperty value) Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function.
void	setRuntime(IResolvable value) Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function.
void	setSyncConfig(CfnFunctionConfiguration.SyncConfigProperty value) Describes a Sync configuration for a resolver.
void	setSyncConfig(IResolvable value) Describes a Sync configuration for a resolver.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnFunctionConfiguration

protected CfnFunctionConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

CfnFunctionConfiguration

protected CfnFunctionConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnFunctionConfiguration

public CfnFunctionConfiguration(Construct scope,
                                java.lang.String id,
                                CfnFunctionConfigurationProps props)

Create a new `AWS::AppSync::FunctionConfiguration`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDataSourceName

public java.lang.String getAttrDataSourceName()

The name of data source this function will attach.

getAttrFunctionArn

public java.lang.String getAttrFunctionArn()

ARN of the function, such as `arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/functions/functionId` .

getAttrFunctionId

public java.lang.String getAttrFunctionId()

The unique ID of this function.

getAttrName

public java.lang.String getAttrName()

The name of the function.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApiId

public java.lang.String getApiId()

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

setApiId

public void setApiId(java.lang.String value)

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

getDataSourceName

public java.lang.String getDataSourceName()

The name of data source this function will attach.

setDataSourceName

public void setDataSourceName(java.lang.String value)

The name of data source this function will attach.

getName

public java.lang.String getName()

The name of the function.

setName

public void setName(java.lang.String value)

The name of the function.

getCode

public java.lang.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 .

setCode

public void setCode(java.lang.String value)

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

public java.lang.String getCodeS3Location()

The Amazon S3 endpoint.

setCodeS3Location

public void setCodeS3Location(java.lang.String value)

The Amazon S3 endpoint.

getDescription

public java.lang.String getDescription()

The `Function` description.

setDescription

public void setDescription(java.lang.String value)

The `Function` description.

getFunctionVersion

public java.lang.String getFunctionVersion()

The version of the request mapping template.

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

setFunctionVersion

public void setFunctionVersion(java.lang.String value)

The version of the request mapping template.

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

getMaxBatchSize

public java.lang.Number getMaxBatchSize()

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

setMaxBatchSize

public void setMaxBatchSize(java.lang.Number value)

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

getRequestMappingTemplate

public java.lang.String getRequestMappingTemplate()

The `Function` request mapping template.

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

setRequestMappingTemplate

public void setRequestMappingTemplate(java.lang.String value)

The `Function` request mapping template.

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

getRequestMappingTemplateS3Location

public java.lang.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.

setRequestMappingTemplateS3Location

public void setRequestMappingTemplateS3Location(java.lang.String value)

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

public java.lang.String getResponseMappingTemplate()

The `Function` response mapping template.

setResponseMappingTemplate

public void setResponseMappingTemplate(java.lang.String value)

The `Function` response mapping template.

getResponseMappingTemplateS3Location

public java.lang.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.

setResponseMappingTemplateS3Location

public void setResponseMappingTemplateS3Location(java.lang.String value)

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

public java.lang.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.

setRuntime

public void setRuntime(IResolvable value)

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.

setRuntime

public void setRuntime(CfnFunctionConfiguration.AppSyncRuntimeProperty value)

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

public java.lang.Object getSyncConfig()

Describes a Sync configuration for a resolver.

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

setSyncConfig

public void setSyncConfig(IResolvable value)

Describes a Sync configuration for a resolver.

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

setSyncConfig

public void setSyncConfig(CfnFunctionConfiguration.SyncConfigProperty value)

Describes a Sync configuration for a resolver.

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