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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-functionconfiguration.html

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;

CfnFunctionConfigurationProps cfnFunctionConfigurationProps = new CfnFunctionConfigurationProps {
    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 = 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.
DataSourceName	The name of data source this function will attach.
Description	The `Function` description.
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 `BatchInvoke` operation.
Name	The name of the function.
RequestMappingTemplate	The `Function` request mapping template.
RequestMappingTemplateS3Location	Describes a Sync configuration for a resolver.
ResponseMappingTemplate	The `Function` response mapping template.
ResponseMappingTemplateS3Location	The location of a response mapping template in an Amazon S3 bucket.
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

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

DataSourceName

The name of data source this function will attach.

string DataSourceName { get; }

Property Value

System.String

Remarks

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

Description

The Function description.

virtual string Description { get; }

Property Value

System.String

Remarks

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

FunctionVersion

The version of the request mapping template.

string FunctionVersion { get; }

Property Value

System.String

Remarks

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

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

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

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

Name

The name of the function.

string Name { get; }

Property Value

System.String

Remarks

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

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.

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

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.

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

ResponseMappingTemplate

The Function response mapping template.

virtual string ResponseMappingTemplate { get; }

Property Value

System.String

Remarks

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

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.

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

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.

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