class CfnResolver (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.AppSync.CfnResolver`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#CfnResolver`
Java	`software.amazon.awscdk.services.appsync.CfnResolver`
Python	`aws_cdk.aws_appsync.CfnResolver`
TypeScript	`aws-cdk-lib` » `aws_appsync` » `CfnResolver`

Implements IConstruct, IDependable, IInspectable

The AWS::AppSync::Resolver resource defines the logical GraphQL resolver that you attach to fields in a schema.

Request and response templates for resolvers are written in Apache Velocity Template Language (VTL) format. For more information about resolvers, see Resolver Mapping Template Reference .

When you submit an update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CloudFormation template. Changing the Amazon S3 file content without changing a property value will not result in an update operation.

See Update Behaviors of Stack Resources in the AWS CloudFormation User Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
const cfnResolver = new appsync.CfnResolver(this, 'MyCfnResolver', {
  apiId: 'apiId',
  fieldName: 'fieldName',
  typeName: 'typeName',

  // the properties below are optional
  cachingConfig: {
    ttl: 123,

    // the properties below are optional
    cachingKeys: ['cachingKeys'],
  },
  code: 'code',
  codeS3Location: 'codeS3Location',
  dataSourceName: 'dataSourceName',
  kind: 'kind',
  maxBatchSize: 123,
  metricsConfig: 'metricsConfig',
  pipelineConfig: {
    functions: ['functions'],
  },
  requestMappingTemplate: 'requestMappingTemplate',
  requestMappingTemplateS3Location: 'requestMappingTemplateS3Location',
  responseMappingTemplate: 'responseMappingTemplate',
  responseMappingTemplateS3Location: 'responseMappingTemplateS3Location',
  runtime: {
    name: 'name',
    runtimeVersion: 'runtimeVersion',
  },
  syncConfig: {
    conflictDetection: 'conflictDetection',

    // the properties below are optional
    conflictHandler: 'conflictHandler',
    lambdaConflictHandlerConfig: {
      lambdaConflictHandlerArn: 'lambdaConflictHandlerArn',
    },
  },
});

Initializer

new CfnResolver(scope: Construct, id: string, props: CfnResolverProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnResolverProps — Resource properties.

Construct Props

Name	Type	Description
apiId	`string`	The AWS AppSync GraphQL API to which you want to attach this resolver.
fieldName	`string`	The GraphQL field on a type that invokes the resolver.
typeName	`string`	The GraphQL type that invokes this resolver.
cachingConfig?	`IResolvable` `\|` `CachingConfigProperty`	The caching configuration for the resolver.
code?	`string`	The `resolver` code that contains the request and response functions.
codeS3Location?	`string`	The Amazon S3 endpoint.
dataSourceName?	`string`	The resolver data source name.
kind?	`string`	The resolver type.
maxBatchSize?	`number`	The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a `BatchInvoke` operation.
metricsConfig?	`string`	Enables or disables enhanced resolver metrics for specified resolvers.
pipelineConfig?	`IResolvable` `\|` `PipelineConfigProperty`	Functions linked with the pipeline resolver.
requestMappingTemplate?	`string`	The request mapping template.
requestMappingTemplateS3Location?	`string`	The location of a request mapping template in an Amazon S3 bucket.
responseMappingTemplate?	`string`	The response mapping template.
responseMappingTemplateS3Location?	`string`	The location of a response mapping template in an Amazon S3 bucket.
runtime?	`IResolvable` `\|` `AppSyncRuntimeProperty`	Describes a runtime used by an AWS AppSync resolver or AWS AppSync function.
syncConfig?	`IResolvable` `\|` `SyncConfigProperty`	The `SyncConfig` for a resolver attached to a versioned data source.

apiId

Type: string

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

fieldName

Type: string

The GraphQL field on a type that invokes the resolver.

typeName

Type: string

The GraphQL type that invokes this resolver.

cachingConfig?

Type: IResolvable | CachingConfigProperty (optional)

The caching configuration for the resolver.

code?

Type: string (optional)

The resolver code that contains the request and response functions.

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

codeS3Location?

Type: string (optional)

The Amazon S3 endpoint.

dataSourceName?

Type: string (optional)

The resolver data source name.

kind?

Type: string (optional)

The resolver type.

UNIT : A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
PIPELINE : A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.

maxBatchSize?

Type: number (optional)

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

metricsConfig?

Type: string (optional)

Enables or disables enhanced resolver metrics for specified resolvers.

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.

pipelineConfig?

Type: IResolvable | PipelineConfigProperty (optional)

Functions linked with the pipeline resolver.

requestMappingTemplate?

Type: string (optional)

The request mapping template.

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

requestMappingTemplateS3Location?

Type: string (optional)

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

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

responseMappingTemplate?

Type: string (optional)

The response mapping template.

responseMappingTemplateS3Location?

Type: string (optional)

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

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

runtime?

Type: IResolvable | AppSyncRuntimeProperty (optional)

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

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

syncConfig?

Type: IResolvable | SyncConfigProperty (optional)

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

Properties

Name	Type	Description
apiId	`string`	The AWS AppSync GraphQL API to which you want to attach this resolver.
attrFieldName	`string`	The GraphQL field on a type that invokes the resolver.
attrResolverArn	`string`	ARN of the resolver, such as `arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/types/typename/resolvers/resolvername` .
attrTypeName	`string`	The GraphQL type that invokes this resolver.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
fieldName	`string`	The GraphQL field on a type that invokes the resolver.
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
typeName	`string`	The GraphQL type that invokes this resolver.
cachingConfig?	`IResolvable` `\|` `CachingConfigProperty`	The caching configuration for the resolver.
code?	`string`	The `resolver` code that contains the request and response functions.
codeS3Location?	`string`	The Amazon S3 endpoint.
dataSourceName?	`string`	The resolver data source name.
kind?	`string`	The resolver type.
maxBatchSize?	`number`	The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a `BatchInvoke` operation.
metricsConfig?	`string`	Enables or disables enhanced resolver metrics for specified resolvers.
pipelineConfig?	`IResolvable` `\|` `PipelineConfigProperty`	Functions linked with the pipeline resolver.
requestMappingTemplate?	`string`	The request mapping template.
requestMappingTemplateS3Location?	`string`	The location of a request mapping template in an Amazon S3 bucket.
responseMappingTemplate?	`string`	The response mapping template.
responseMappingTemplateS3Location?	`string`	The location of a response mapping template in an Amazon S3 bucket.
runtime?	`IResolvable` `\|` `AppSyncRuntimeProperty`	Describes a runtime used by an AWS AppSync resolver or AWS AppSync function.
syncConfig?	`IResolvable` `\|` `SyncConfigProperty`	The `SyncConfig` for a resolver attached to a versioned data source.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

apiId

Type: string

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

attrFieldName

Type: string

The GraphQL field on a type that invokes the resolver.

attrResolverArn

Type: string

ARN of the resolver, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/types/typename/resolvers/resolvername .

attrTypeName

Type: string

The GraphQL type that invokes this resolver.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

fieldName

Type: string

The GraphQL field on a type that invokes the resolver.

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: Node

The tree node.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

typeName

Type: string

The GraphQL type that invokes this resolver.

cachingConfig?

Type: IResolvable | CachingConfigProperty (optional)

The caching configuration for the resolver.

code?

Type: string (optional)

The resolver code that contains the request and response functions.

codeS3Location?

Type: string (optional)

The Amazon S3 endpoint.

dataSourceName?

Type: string (optional)

The resolver data source name.

kind?

Type: string (optional)

The resolver type.

maxBatchSize?

Type: number (optional)

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

metricsConfig?

Type: string (optional)

Enables or disables enhanced resolver metrics for specified resolvers.

pipelineConfig?

Type: IResolvable | PipelineConfigProperty (optional)

Functions linked with the pipeline resolver.

requestMappingTemplate?

Type: string (optional)

The request mapping template.

requestMappingTemplateS3Location?

Type: string (optional)

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

responseMappingTemplate?

Type: string (optional)

The response mapping template.

responseMappingTemplateS3Location?

Type: string (optional)

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

runtime?

Type: IResolvable | AppSyncRuntimeProperty (optional)

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

syncConfig?

Type: IResolvable | SyncConfigProperty (optional)

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

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }