Class CfnFunctionConfigurationProps

Properties for defining a CfnFunctionConfiguration.

Inheritance

object

CfnFunctionConfigurationProps

Implements

ICfnFunctionConfigurationProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnFunctionConfigurationProps : ICfnFunctionConfigurationProps

Syntax (vb)

Public Class CfnFunctionConfigurationProps Implements ICfnFunctionConfigurationProps

Remarks

See: 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;

             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

Constructors

CfnFunctionConfigurationProps()

Properties for defining a CfnFunctionConfiguration.

Properties

ApiId	The AWS AppSync GraphQL API that you want to attach using this function.
Code	The `resolver` code that contains the request and response functions.
CodeS3Location	The Amazon S3 endpoint.
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.
Runtime	Describes a runtime used by an AWS AppSync resolver or AWS AppSync function.
SyncConfig	Describes a Sync configuration for a resolver.

Constructors

CfnFunctionConfigurationProps()

Properties for defining a CfnFunctionConfiguration.

public CfnFunctionConfigurationProps()

Remarks

See: 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;

             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"
                     }
                 }
             };

Properties

ApiId

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

public string ApiId { get; set; }

Property Value

string

Remarks

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

Code

The resolver code that contains the request and response functions.

public string? Code { get; set; }

Property Value

string

Remarks

When code is used, the runtime is required. The runtime value must be APPSYNC_JS .

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

CodeS3Location

The Amazon S3 endpoint.

public string? CodeS3Location { get; set; }

Property Value

string

Remarks

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

DataSourceName

The name of data source this function will attach.

public string DataSourceName { get; set; }

Property Value

string

Remarks

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

Description

The Function description.

public string? Description { get; set; }

Property Value

string

Remarks

See: 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.

public string? FunctionVersion { get; set; }

Property Value

string

Remarks

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

See: 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.

public double? MaxBatchSize { get; set; }

Property Value

double?

Remarks

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

Name

The name of the function.

public string Name { get; set; }

Property Value

string

Remarks

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

RequestMappingTemplate

The Function request mapping template.

public string? RequestMappingTemplate { get; set; }

Property Value

string

Remarks

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

See: 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.

public string? RequestMappingTemplateS3Location { get; set; }

Property Value

string

Remarks

Contains information on which Conflict Detection, as well as Resolution strategy, should be performed when the resolver is invoked.

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

ResponseMappingTemplate

The Function response mapping template.

public string? ResponseMappingTemplate { get; set; }

Property Value

string

Remarks

See: 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.

public string? ResponseMappingTemplateS3Location { get; set; }

Property Value

string

Remarks

Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.

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

Runtime

Describes a runtime used by an AWS AppSync resolver or AWS AppSync function.

public object? Runtime { get; set; }

Property Value

object

Remarks

Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.

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

SyncConfig

Describes a Sync configuration for a resolver.

public object? SyncConfig { get; set; }

Property Value

object

Remarks

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

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

Implements

ICfnFunctionConfigurationProps