Managing cache key cookies
When you deploy your app to Amplify, you can choose whether you want to include or exclude cookies in the cache key. In the Amplify console, this setting is specified on the Custom headers and cache page using the Cache key settings toggle. For instructions, see Including or excluding cookies from the cache key.
- Include cookies in the cache key
-
This is the default cache configuration. With this setting, Amplify automatically chooses an optimal cache configuration for your app based on the type of content that is being served.
If you are using the SDKs or the AWS CLI, this setting corresponds to setting
cacheConfig.typetoAMPLIFY_MANAGEDwith theCreateApporUpdateAppAPIs. - Exclude cookies from the cache key
-
This cache configuration is similar to the default configuration, except that it excludes all cookies from the cache key. You must explicitly choose this cache configuration type.
Choosing to exclude cookies from the cache key can result in better cache performance. However, before you choose this cache configuration, it is important to consider whether your app uses cookies to serve dynamic content.
If you are using the SDKs or the AWS CLI, this setting corresponds to setting the
cacheConfig.typetoAMPLIFY_MANAGED_NO_COOKIESwith theCreateApporUpdateAppAPIs.
For more information about the cache key, see Understand the cache key in the Amazon CloudFront Developer Guide;.
Including or excluding cookies from the cache key
You can set the cache key cookie configuration for an app in the Amplify console, SDKs, or the AWS CLI.
Use the following procedure to specify whether to include or exclude cookies from the cache key when you are deploying a new app using the Amplify console.
To set the cache key cookie configuration when deploying an app to Amplify
-
Sign in to the AWS Management Console and open the Amplify console
. -
On the All apps page, choose Create new app.
-
On the Start building with Amplify page, choose your Git repository provider, then choose Next.
-
On the Add repository branch page, do the following:
-
Select the name of the repository to connect.
-
Select the name of the repository branch to connect.
-
Choose Next.
-
-
If the app requires an IAM service role, you can either allow Amplify Hosting compute to automatically create a service role for you or you can specify a role that you have created.
-
To allow Amplify to automatically create a role and attach it to your app:
-
Choose Create and use a new service role.
-
-
To attach a service role that you previously created:
-
Choose Use an existing service role.
-
Select the role to use from the list.
-
-
-
Choose Advanced settings, then locate the Cache key settings section.
-
Choose either Keep cookies in cache key or Remove cookies from cache key. The following screenshot shows the Cache key settings toggle in the console.
-
Choose Next.
-
On the Review page, choose Save and deploy.
Changing the cache key cookie configuration for an app
You can change the cache key cookie configuration for an app that is already deployed to Amplify. Use the following procedure to change whether to include or exclude cookies from the cache key for an app using the Amplify console.
To change the cache key cookie configuration for a deployed app
-
Sign in to the AWS Management Console and open the Amplify console
. -
On the All apps page, choose the application you want to update.
-
In the navigation pane, choose Hosting, then choose Custom headers and cache.
-
On the Custom headers and cache page, locate the Cache key settings section and choose Edit.
-
Choose either Keep cookies in cache key or Remove cookies from cache key. The following screenshot shows the Cache key settings toggle in the console.
-
Choose Save.
