software.amazon.awscdk.services.appsync

Class CfnFunctionConfiguration

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.appsync.CfnFunctionConfiguration

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.675Z")
 @Stability(value=Stable)
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")
         .functionVersion("functionVersion")
         .name("name")
         // the properties below are optional
         .description("description")
         .maxBatchSize(123)
         .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	Class and Description
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnFunctionConfiguration(software.constructs.Construct scope, 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
String	getApiId() The AWS AppSync GraphQL API that you want to attach using this function.
String	getAttrDataSourceName() The name of data source this function will attach.
String	getAttrFunctionArn() ARN of the function, such as `arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/functions/functionId` .
String	getAttrFunctionId() The unique ID of this function.
String	getAttrName() The name of the function.
protected Map<String,Object>	getCfnProperties()
String	getDataSourceName() The name of data source this function will attach.
String	getDescription() The `Function` description.
String	getFunctionVersion() The version of the request mapping template.
Number	getMaxBatchSize() The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a `BatchInvoke` operation.
String	getName() The name of the function.
String	getRequestMappingTemplate() The `Function` request mapping template.
String	getRequestMappingTemplateS3Location() Describes a Sync configuration for a resolver.
String	getResponseMappingTemplate() The `Function` response mapping template.
String	getResponseMappingTemplateS3Location() The location of a response mapping template in an Amazon S3 bucket.
Object	getSyncConfig() Describes a Sync configuration for a resolver.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApiId(String value) The AWS AppSync GraphQL API that you want to attach using this function.
void	setDataSourceName(String value) The name of data source this function will attach.
void	setDescription(String value) The `Function` description.
void	setFunctionVersion(String value) The version of the request mapping template.
void	setMaxBatchSize(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(String value) The name of the function.
void	setRequestMappingTemplate(String value) The `Function` request mapping template.
void	setRequestMappingTemplateS3Location(String value) Describes a Sync configuration for a resolver.
void	setResponseMappingTemplate(String value) The `Function` response mapping template.
void	setResponseMappingTemplateS3Location(String value) The location of a response mapping template in an Amazon S3 bucket.
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.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnFunctionConfiguration(@NotNull
                                                         software.constructs.Construct scope,
                                                         @NotNull
                                                         String id,
                                                         @NotNull
                                                         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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDataSourceName

@Stability(value=Stable)
 @NotNull
public String getAttrDataSourceName()

The name of data source this function will attach.

getAttrFunctionArn

@Stability(value=Stable)
 @NotNull
public String getAttrFunctionArn()

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

getAttrFunctionId

@Stability(value=Stable)
 @NotNull
public String getAttrFunctionId()

The unique ID of this function.

getAttrName

@Stability(value=Stable)
 @NotNull
public String getAttrName()

The name of the function.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApiId

@Stability(value=Stable)
 @NotNull
public String getApiId()

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

setApiId

@Stability(value=Stable)
public void setApiId(@NotNull
                                              String value)

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

getDataSourceName

@Stability(value=Stable)
 @NotNull
public String getDataSourceName()

The name of data source this function will attach.

setDataSourceName

@Stability(value=Stable)
public void setDataSourceName(@NotNull
                                                       String value)

The name of data source this function will attach.

getFunctionVersion

@Stability(value=Stable)
 @NotNull
public String getFunctionVersion()

The version of the request mapping template.

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

setFunctionVersion

@Stability(value=Stable)
public void setFunctionVersion(@NotNull
                                                        String value)

The version of the request mapping template.

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

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the function.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the function.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The `Function` description.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The `Function` description.

getMaxBatchSize

@Stability(value=Stable)
 @Nullable
public Number getMaxBatchSize()

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

setMaxBatchSize

@Stability(value=Stable)
public void setMaxBatchSize(@Nullable
                                                     Number value)

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

getRequestMappingTemplate

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

The `Function` request mapping template.

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

setRequestMappingTemplate

@Stability(value=Stable)
public void setRequestMappingTemplate(@Nullable
                                                               String value)

The `Function` request mapping template.

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

getRequestMappingTemplateS3Location

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setRequestMappingTemplateS3Location(@Nullable
                                                                         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

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

The `Function` response mapping template.

setResponseMappingTemplate

@Stability(value=Stable)
public void setResponseMappingTemplate(@Nullable
                                                                String value)

The `Function` response mapping template.

getResponseMappingTemplateS3Location

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setResponseMappingTemplateS3Location(@Nullable
                                                                          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.

getSyncConfig

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setSyncConfig(@Nullable
                                                   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.

setSyncConfig

@Stability(value=Stable)
public void setSyncConfig(@Nullable
                                                   IResolvable value)

Describes a Sync configuration for a resolver.

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