Back to Serverless

Caching

docs/sf/providers/aws/guide/appsync/caching.md

4.29.01.4 KB
Original Source
<!-- title: Serverless Framework - AppSync - Caching description: How to configure caching for AWS AppSync with the Serverless Framework. short_title: AppSync - Caching keywords: [ 'Serverless Framework', 'AppSync', 'Caching', 'GraphQL', 'AWS', ] -->

Caching

AppSync supports server-side data caching. You can find the caching configuration under the appSync.caching attribute.

Quick start

yaml
appSync:
  name: my-api
  caching:
    behavior: 'PER_RESOLVER_CACHING'
    type: 'SMALL'
    ttl: 3600
    atRestEncryption: false
    transitEncryption: false

Configuration

  • behavior: FULL_REQUEST_CACHING or PER_RESOLVER_CACHING
  • type: The type of the Redis instance. SMALL, MEDIUM, LARGE, XLARGE, LARGE_2X, LARGE_4X, LARGE_8X, LARGE_12X. Defaults to SMALL
  • ttl: The default TTL of the cache in seconds. Defaults to 3600. Maximum is 3600
  • enabled: Boolean. Whether caching is enabled. Defaults to true when the caching definition is present.
  • atRestEncryption: Boolean. Whether to encrypt the data at rest. Defaults to false
  • transitEncryption: Boolean. Whether to encrypt the data in transit. Defaults to false

Per resolver caching

See Resolver caching

Flushing the cache

You can use the flush-cache command to easily flush the cache.