Skip to content
v2.274.0

SyncConfigProperty Struct ​

Describes a Sync configuration for a resolver.

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

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
const syncConfigProperty: appsync.CfnFunctionConfiguration.SyncConfigProperty = {
  conflictDetection: 'conflictDetection',

  // the properties below are optional
  conflictHandler: 'conflictHandler',
  lambdaConflictHandlerConfig: {
    lambdaConflictHandlerArn: 'lambdaConflictHandlerArn',
  },
};

Properties ​

conflictDetectionstringconflict_detectionstrconflictDetectionStringConflictDetectionstringConflictDetection*stringrequired#
The Conflict Detection strategy to use.
  • VERSION : Detect conflicts based on object versions for this resolver.
  • NONE : Do not detect conflicts when invoking this resolver.
conflictHandleroptionalstringconflict_handleroptionalstrconflictHandleroptionalStringConflictHandleroptionalstringConflictHandleroptional*string#
The Conflict Resolution strategy to perform in the event of a conflict.
notes
  • OPTIMISTIC_CONCURRENCY : Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.
  • AUTOMERGE : Resolve conflicts with the Automerge conflict resolution strategy.
  • LAMBDA : Resolve conflicts with an AWS Lambda function supplied in the LambdaConflictHandlerConfig .
lambdaConflictHandlerConfigoptionalIResolvable | CfnFunctionConfiguration.LambdaConflictHandlerConfigPropertylambda_conflict_handler_configoptionaltyping.Union[IResolvable, LambdaConflictHandlerConfigProperty]lambdaConflictHandlerConfigoptionalIResolvableLambdaConflictHandlerConfigoptionalIResolvableLambdaConflictHandlerConfigoptionalinterface{}#
The `LambdaConflictHandlerConfig` when configuring `LAMBDA` as the Conflict Handler.