Interface ICfnFunctionConfigurationProps
Properties for defining a CfnFunctionConfiguration
.
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.AWS.AppSync.dll
Syntax (csharp)
public interface ICfnFunctionConfigurationProps
Syntax (vb)
Public Interface ICfnFunctionConfigurationProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppSync;
var cfnFunctionConfigurationProps = new CfnFunctionConfigurationProps {
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 = new AppSyncRuntimeProperty {
Name = "name",
RuntimeVersion = "runtimeVersion"
},
SyncConfig = new SyncConfigProperty {
ConflictDetection = "conflictDetection",
// the properties below are optional
ConflictHandler = "conflictHandler",
LambdaConflictHandlerConfig = new LambdaConflictHandlerConfigProperty {
LambdaConflictHandlerArn = "lambdaConflictHandlerArn"
}
}
};
Synopsis
Properties
ApiId | The AWS AppSync GraphQL API that you want to attach using this function. |
Code | The |
CodeS3Location | The Amazon S3 endpoint. |
DataSourceName | The name of data source this function will attach. |
Description | The |
FunctionVersion | The version of the request mapping template. |
MaxBatchSize | The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a |
Name | The name of the function. |
RequestMappingTemplate | The |
RequestMappingTemplateS3Location | Describes a Sync configuration for a resolver. |
ResponseMappingTemplate | The |
ResponseMappingTemplateS3Location | The location of a response mapping template in an Amazon S3 bucket. |
Runtime | Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. |
SyncConfig | Describes a Sync configuration for a resolver. |
Properties
ApiId
The AWS AppSync GraphQL API that you want to attach using this function.
string ApiId { get; }
Property Value
System.String
Remarks
Code
The resolver
code that contains the request and response functions.
virtual string Code { get; }
Property Value
System.String
Remarks
When code is used, the runtime
is required. The runtime value must be APPSYNC_JS
.
CodeS3Location
The Amazon S3 endpoint.
virtual string CodeS3Location { get; }
Property Value
System.String
Remarks
DataSourceName
The name of data source this function will attach.
string DataSourceName { get; }
Property Value
System.String
Remarks
Description
The Function
description.
virtual string Description { get; }
Property Value
System.String
Remarks
FunctionVersion
The version of the request mapping template.
virtual string FunctionVersion { get; }
Property Value
System.String
Remarks
Currently, only the 2018-05-29 version of the template is supported.
MaxBatchSize
The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke
operation.
virtual Nullable<double> MaxBatchSize { get; }
Property Value
System.Nullable<System.Double>
Remarks
Name
The name of the function.
string Name { get; }
Property Value
System.String
Remarks
RequestMappingTemplate
The Function
request mapping template.
virtual string RequestMappingTemplate { get; }
Property Value
System.String
Remarks
Functions support only the 2018-05-29 version of the request mapping template.
RequestMappingTemplateS3Location
Describes a Sync configuration for a resolver.
virtual string RequestMappingTemplateS3Location { get; }
Property Value
System.String
Remarks
Contains information on which Conflict Detection, as well as Resolution strategy, should be performed when the resolver is invoked.
ResponseMappingTemplate
The Function
response mapping template.
virtual string ResponseMappingTemplate { get; }
Property Value
System.String
Remarks
ResponseMappingTemplateS3Location
The location of a response mapping template in an Amazon S3 bucket.
virtual string ResponseMappingTemplateS3Location { get; }
Property Value
System.String
Remarks
Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.
Runtime
Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function.
virtual object Runtime { get; }
Property Value
System.Object
Remarks
Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
SyncConfig
Describes a Sync configuration for a resolver.
virtual object SyncConfig { get; }
Property Value
System.Object
Remarks
Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.