Skip to main content

Documentation Index

Fetch the complete documentation index at: https://cloud.laravel.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Introduction

Laravel Cloud provides fully managed AWS ElastiCache caches (both Valkey and Redis OSS) for your application. ElastiCache offers powerful features, including automatic failover, Multi-AZ deployments, in-place version upgrades, and high-throughput, low-latency performance backed by AWS infrastructure.
ElastiCache is only available with Private Cloud. If you do not see ElastiCache as an option when creating a cache, please contact us to provision a dedicated cluster in your chosen region.

​
Creating ElastiCache caches

To create and attach an ElastiCache cache to an environment:
  1. Navigate to “Organization > Resources > Caches”
  2. Click ”+ New cache”
    • Cache name: A unique name for your ElastiCache cache
    • Type: Choose between AWS ElastiCache Valkey or AWS ElastiCache Redis
    • Region: Choose a Private Cloud region
    • Configuration: Choose a preset or customize your ElastiCache configuration
It may take up to 20 minutes for your ElastiCache cache to be fully created. You do not need to stay on the page.
Once created, you can attach the cache to any environment in the same region. When attaching a cache to an environment, you will need to redeploy the environment for the changes to take effect. Contact us for information on ElastiCache pricing per region.

​
Customizing ElastiCache caches

Laravel Cloud offers you complete control over your ElastiCache configuration. When creating or editing an ElastiCache cluster, you may control the following:

​
Choosing the right node size

Laravel Cloud supports a range of node sizes from the cache.r7g instance family. The amount of RAM your node has determines how much data your cache can hold and the number of concurrent connections it can support. You can update your node size at any point. Scaling up or down is performed online with no downtime when Multi-AZ is enabled.

​
Selecting a deployment option

Laravel Cloud supports the following ElastiCache deployment options:
  • Single-AZ cache instance. One node in a single availability zone. Best for dev or non-critical workloads.
  • Single-AZ cache instance, with read replicas. One primary node plus up to 5 read replicas for read-heavy workloads and high availability.
  • Multi-AZ cache instance. Data is partitioned across multiple shards, with each shard supporting its own primary and replica nodes. Best for workloads requiring high throughput or large datasets.
Multi-AZ deployments require at least one replica node and provide automatic failover if the primary node becomes unavailable.

​
Picking a maintenance window

AWS may occasionally need to perform maintenance on your ElastiCache cluster, which may cause brief failover events. You can control your scheduled maintenance window by clicking “Edit settings > Maintenance window” and picking a day and 30-minute time slot. If you don’t pick a specific time slot, AWS will perform those updates during the default time slot for your region.

​
Connecting to ElastiCache caches

​
From your application

When a cache is attached to an environment, Laravel Cloud will automatically inject the environment variables needed by the Laravel application to interact with the cache via the Cache facade, including the CACHE_STORE, REDIS_HOST, and REDIS_PASSWORD variables. You may view these variables in your “Environment > Settings > General > Injected variables”.

​
From your local machine

ElastiCache caches are not publicly accessible by default and are only reachable from within your Private Cloud network.

​
Detaching and deleting your cache

If a KV store is no longer needed in your project, you can detach it from your application canvas.
Detaching a KV store does not delete the store. As KV stores can be shared across many applications, you cannot directly delete a KV store from your application, only detach it.KV stores are billed for their availability, regardless of whether they are in use by an application. To permanently delete a KV store, you should visit your organization’s “Resources” page.
You may delete an ElastiCache cluster via your organization’s “Resources” page. From the “Resources” page, navigate to the “Caches” tab and click the ”…” icon for the cluster you would like to delete. Then, click “Delete cache”.

​
Cache backups

Laravel Cloud ElastiCache caches support automated daily backups.

​
Backup configuration

To configure backups for your ElastiCache cluster:
  1. Navigate to “Organization > Resources > Caches”
  2. Click on your ElastiCache cluster
  3. Click “Backups”
  4. Select a backup type:
    • Daily backups: Enable automatic daily backups
    • None: Disable automatic backups

​
Backup retention period

If you select daily backups, you can configure the retention period from 1-35 days. Automatic backups are taken once per day during your cluster’s snapshot window. Contact us for information on ElastiCache backup storage costs.

​
Monitoring ElastiCache performance

To view metrics such as throughput, cache storage and cache hit / miss ratio for your ElastiCache clusters, navigate to “Organization > Resources > Caches”, click on your cluster, and click the “Metrics” option. If you have replicas enabled, you may drill into the performance of each replica separately using the dropdown.