Class CfnResolverProps

Properties for defining a CfnResolver.

Inheritance

System.Object

CfnResolverProps

Implements

ICfnResolverProps

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.AWS.AppSync.dll

Syntax (csharp)

public class CfnResolverProps : Object, ICfnResolverProps

Syntax (vb)

Public Class CfnResolverProps
    Inherits Object
    Implements ICfnResolverProps

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.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 cfnResolverProps = new CfnResolverProps {
    ApiId = "apiId",
    FieldName = "fieldName",
    TypeName = "typeName",

    // the properties below are optional
    CachingConfig = new CachingConfigProperty {
        Ttl = 123,

        // the properties below are optional
        CachingKeys = new [] { "cachingKeys" }
    },
    Code = "code",
    CodeS3Location = "codeS3Location",
    DataSourceName = "dataSourceName",
    Kind = "kind",
    MaxBatchSize = 123,
    PipelineConfig = new PipelineConfigProperty {
        Functions = new [] { "functions" }
    },
    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

CfnResolverProps()

Properties

ApiId	The AWS AppSync GraphQL API to which you want to attach this resolver.
CachingConfig	The caching configuration for the resolver.
Code	The resolver code that contains the request and response functions.
CodeS3Location	The Amazon S3 endpoint.
DataSourceName	The resolver data source name.
FieldName	The GraphQL field on a type that invokes the resolver.
Kind	The resolver type.
MaxBatchSize	The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.
PipelineConfig	Functions linked with the pipeline resolver.
RequestMappingTemplate	The request mapping template.
RequestMappingTemplateS3Location	The location of a request mapping template in an Amazon S3 bucket.
ResponseMappingTemplate	The 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 pipeline resolver or AWS AppSync function.
SyncConfig	The SyncConfig for a resolver attached to a versioned data source.
TypeName	The GraphQL type that invokes this resolver.

Constructors

CfnResolverProps()

public CfnResolverProps()

Properties

ApiId

The AWS AppSync GraphQL API to which you want to attach this resolver.

public string ApiId { get; set; }

Property Value

System.String

Remarks

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

CachingConfig

The caching configuration for the resolver.

public object CachingConfig { get; set; }

Property Value

System.Object

Remarks

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

Code

The resolver code that contains the request and response functions.

public string Code { get; set; }

Property Value

System.String

Remarks

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

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

CodeS3Location

The Amazon S3 endpoint.

public string CodeS3Location { get; set; }

Property Value

System.String

Remarks

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

DataSourceName

The resolver data source name.

public string DataSourceName { get; set; }

Property Value

System.String

Remarks

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

FieldName

The GraphQL field on a type that invokes the resolver.

public string FieldName { get; set; }

Property Value

System.String

Remarks

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

Kind

The resolver type.

public string Kind { get; set; }

Property Value

System.String

Remarks

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

MaxBatchSize

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

public Nullable<double> MaxBatchSize { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

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

PipelineConfig

Functions linked with the pipeline resolver.

public object PipelineConfig { get; set; }

Property Value

System.Object

Remarks

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

RequestMappingTemplate

The request mapping template.

public string RequestMappingTemplate { get; set; }

Property Value

System.String

Remarks

Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.

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

RequestMappingTemplateS3Location

The location of a request mapping template in an Amazon S3 bucket.

public string RequestMappingTemplateS3Location { get; set; }

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-resolver.html#cfn-appsync-resolver-requestmappingtemplates3location

ResponseMappingTemplate

The response mapping template.

public string ResponseMappingTemplate { get; set; }

Property Value

System.String

Remarks

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

ResponseMappingTemplateS3Location

The location of a response mapping template in an Amazon S3 bucket.

public string ResponseMappingTemplateS3Location { get; set; }

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-resolver.html#cfn-appsync-resolver-responsemappingtemplates3location

Runtime

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

public object Runtime { get; set; }

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.

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

SyncConfig

The SyncConfig for a resolver attached to a versioned data source.

public object SyncConfig { get; set; }

Property Value

System.Object

Remarks

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

TypeName

The GraphQL type that invokes this resolver.

public string TypeName { get; set; }

Property Value

System.String

Remarks

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

Implements

ICfnResolverProps