Interface ICfnResolverProps

Properties for defining a CfnResolver.

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnResolverProps

Syntax (vb)

Public Interface ICfnResolverProps

Remarks

See: 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,
                 MetricsConfig = "metricsConfig",
                 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

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.
MetricsConfig	Enables or disables enhanced resolver metrics for specified resolvers.
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 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.

Properties

ApiId

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

string ApiId { get; }

Property Value

string

Remarks

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

CachingConfig

The caching configuration for the resolver.

object? CachingConfig { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnResolver.ICachingConfigProperty

Code

The resolver code that contains the request and response functions.

string? Code { get; }

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

CodeS3Location

The Amazon S3 endpoint.

string? CodeS3Location { get; }

Property Value

string

Remarks

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

DataSourceName

The resolver data source name.

string? DataSourceName { get; }

Property Value

string

Remarks

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

string FieldName { get; }

Property Value

string

Remarks

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

Kind

The resolver type.

string? Kind { get; }

Property Value

string

Remarks

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

double? MaxBatchSize { get; }

Property Value

double?

Remarks

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

MetricsConfig

Enables or disables enhanced resolver metrics for specified resolvers.

string? MetricsConfig { get; }

Property Value

string

Remarks

Note that MetricsConfig won't be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS . If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead, MetricsConfig will be ignored. However, you can still set its value.

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

PipelineConfig

Functions linked with the pipeline resolver.

object? PipelineConfig { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnResolver.IPipelineConfigProperty

RequestMappingTemplate

The request mapping template.

string? RequestMappingTemplate { get; }

Property Value

string

Remarks

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

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

string? RequestMappingTemplateS3Location { get; }

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

ResponseMappingTemplate

The response mapping template.

string? ResponseMappingTemplate { get; }

Property Value

string

Remarks

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

string? ResponseMappingTemplateS3Location { get; }

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

Runtime

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

object? Runtime { get; }

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

Type union: either IResolvable or CfnResolver.IAppSyncRuntimeProperty

SyncConfig

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

object? SyncConfig { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnResolver.ISyncConfigProperty

TypeName

The GraphQL type that invokes this resolver.

string TypeName { get; }

Property Value

string

Remarks

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