appsync: API level cache config

[TonySherman]

Describe the feature

The aws_appsync module does not include any L2 constructs to enable caching at the API level. There is a CachingConfig construct but that is specifically for resolvers and cannot be enabled if the API does not have caching enabled itself.

Use Case

There is no way to enable caching on a graphql API outside of cfn constrcuts. I would like to enable this directly in the GraphqlApi construct or via it's own L2 construct.

Proposed Solution

Ideally, it could be configured directly in the GraphqlApi construct:

const api = new appsync.GraphqlApi(this, 'EventBridgeApi', {
  name: 'EventBridgeApi',
  definition: appsync.Definition.fromFile(path.join(__dirname, 'appsync.eventbridge.graphql')),
  cacheConfig: appsync.ApiCacheConfig(...)
});

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

CDK version used

2.153.0

Environment details (OS name and version, etc.)

MacOS 14.6.1, Node v18

[pahud]

Thank you for your feature request.

Looking at the CFN doc for AWS::AppSync::GraphQLApi, I didn't see how an API could configure with cache config.

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html

Can you elaborate more on how a cacheConfig should be passed to a GraphQLApi?

[TonySherman]

@pahud - It's possible that it cannot be added directly to the GraphQLApi construct, but there still is no L2 construct for CfnApiCache. Maybe the usage would actually be:

const api = new appsync.GraphqlApi(this, 'EventBridgeApi', {
  name: 'EventBridgeApi',
  definition: appsync.Definition.fromFile(path.join(__dirname, 'appsync.eventbridge.graphql')),
});

const cache = new appsync.ApiCache(
   api_id: api.api_id
   cache_behavior: appsync.CacheBehavior.FULL_REQUEST_CACHING,
   type: appsync.CacheType.LARGE,
   ...
)

[pahud]

I think we can simply create a addCache method for the GraphqlApi L2 so it would be like

const api = new appsync.GraphqlApi(this, 'EventBridgeApi', {
  name: 'EventBridgeApi',
  definition: appsync.Definition.fromFile(path.join(__dirname, 'appsync.eventbridge.graphql')),
});

api.addCache(this, 'CacheName', {
   cache_behavior: appsync.CacheBehavior.FULL_REQUEST_CACHING,
   type: appsync.CacheType.LARGE,
...};

wdyt? And, if you are interested to submit a PR, you can follow this blog post and we'd be happy to review your PR to have this feature.

[TonySherman]

I like that. I'd be happy to work on a PR! Thanks for the blog post for reference.