Using global datastores (console)

To create a global datastore using an existing cluster

1. Sign in to the Amazon Web Services Management Console and open the ElastiCache console at https://console.amazonaws.cn/elasticache/.

2. On the navigation pane, choose Redis and then choose a cluster.

3. For Actions, choose Setup Global Datastore.

4. On the Setup Global Datastore page, do the following:

   • Enter a value for Global Datastore Name suffix: This suffix is used to generate a unique name for the global datastore. You can search for the global datastore by using the suffix that you specify here.

   • (Optional) Enter a Description value.

5. Under Secondary cluster details, choose a different Amazon Region where the cluster will be stored.

6. Under Redis settings, enter a value for Name and, optionally, for Description for the cluster.

7. Keep the following options as they are. They're prepopulated to match the primary cluster configuration, you can't change them.

   • Engine version

   • Node type

   • Parameter group

     Note

     ElastiCache autogenerates a new parameter group from values of the provided parameter group and applies the new parameter group to the cluster. Use this new parameter group to modify parameters on a global datastore. Each autogenerated parameter group is associated with one and only one cluster and, therefore, only one global datastore.

   • Number of shards

   • Encryption at rest – Enables encryption of data stored on disk. For more information, see Encryption at rest.

     Note

     You can supply a different encryption key by choosing Customer Managed Amazon KMS key and choosing the key. For more information, see Using Customer Managed Amazon KMS keys.

   • Encryption in-transit – Enables encryption of data on the wire. For more information, see Encryption in transit. For Redis engine version 6.0 onwards, if you enable encryption in-transit you are prompted to specify one of the following Access Control options:

     • No Access Control – This is the default setting. This indicates no restrictions.

     • User Group Access Control List – Choose a user group with a defined set of users and permissions on available operations. For more information, see Managing User Groups with the Console and CLI.

     • Redis AUTH Default User – An authentication mechanism for Redis server. For more information, see Redis AUTH.

8. (Optional) As needed, update the remaining secondary cluster settings. These are prepopulated with the same values as the primary cluster, but you can update them to meet specific requirements for that cluster.

   • Port

   • Number of replicas

   • Subnet group

   • Preferred Availability Zone(s)

   • Security groups

   • Customer Managed (Amazon KMS key)

   • Redis AUTH Token

   • Enable automatic backups

   • Backup retention period

   • Backup window

   • Maintenance window

   • Topic for SNS notification

9. Choose Create. Doing this sets the status of the global datastore to Creating. The status transitions to Modifying after the primary cluster is associated to the global datastore and the secondary cluster is in Associating status.

   After the primary cluster and secondary clusters are associated with the global datastore, the status changes to Available. At this point, you have a primary cluster that accepts reads and writes and secondary clusters that accept reads replicated from the primary cluster.

   The Redis page is updated to indicate whether a cluster is part of a global datastore, including:

   • Global Datastore – The name of the global datastore to which the cluster belongs.

   • Global Datastore Role – The role of the cluster, either primary or secondary.

1. Sign in to the Amazon Web Services Management Console and open the ElastiCache console at https://console.amazonaws.cn/elasticache/.

2. On the navigation pane, choose Global Datastore and then choose Create global datastore.

3. Under Primary cluster settings, do the following:

   1. For Cluster mode, choose Enabled or Disabled.

   2. For Global Datastore info enter a value for Name. ElastiCache uses the suffix to generate a unique name for the global datastore. You can search for the global datastore by using the suffix that you specify here.

   3. (Optional) Enter a value for Global Datastore Description.

4. Under Regional cluster:

   1. For Region, choose an available Amazon Region.

   2. Choose Create new regional cluster or Use existing regional cluster

   3. If you choose Create new regional cluster, under Cluster info, enter a name and optional description of the cluster.

   4. Under Location, we recommend you accept the default settings for Multi-AZ and Auto-failover.

5. Under Cluster settings

   1. For Engine version, choose an available version, which is 5.0.6 or later.

   2. For Port, use the default port, 6379. If you have a reason to use a different port, enter the port number.

   3. For Parameter group, choose a parameter group or create a new one. Parameter groups control the runtime parameters of your cluster. For more information on parameter groups, see Redis-specific parameters and Creating a parameter group.

      Note

      When you select a parameter group to set the engine configuration values, that parameter group is applied to all clusters in the global datastore. On the Parameter Groups page, the yes/no Global attribute indicates whether a parameter group is part of a global datastore.

   4. For Node type, choose the down arrow ( ). In the Change node type dialog box, choose a value for Instance family for the node type that you want. Then choose the node type that you want to use for this cluster, and then choose Save.

      For more information, see Choosing your node size.

      If you choose an r6gd node type, data-tiering is automatically enabled. For more information, see Data tiering.

   5. If you are creating a Redis (cluster mode disabled) cluster:

      For Number of replicas, choose the number of replicas that you want for this cluster.

   6. If you are creating a Redis (cluster mode enabled) cluster:

      1. For Number of shards, choose the number of shards (partitions/node groups) that you want for this Redis (cluster mode enabled) cluster.

         For some versions of Redis (cluster mode enabled), you can change the number of shards in your cluster dynamically:

         • Redis 3.2.10 and later – If your cluster is running Redis 3.2.10 or later versions, you can change the number of shards in your cluster dynamically. For more information, see Scaling clusters in Redis (Cluster Mode Enabled).

         • Other Redis versions – If your cluster is running a version of Redis before version 3.2.10, there's another approach. To change the number of shards in your cluster in this case, create a new cluster with the new number of shards. For more information, see Restoring from a backup into a new cache.

      2. For Replicas per shard, choose the number of read replica nodes that you want in each shard.

         The following restrictions exist for Redis (cluster mode enabled).

         • If you have Multi-AZ enabled, make sure that you have at least one replica per shard.

         • The number of replicas is the same for each shard when creating the cluster using the console.

         • The number of read replicas per shard is fixed and cannot be changed. If you find you need more or fewer replicas per shard (API/CLI: node group), you must create a new cluster with the new number of replicas. For more information, see Seeding a new self-designed cluster with an externally created backup.

6. For Subnet group settings, choose the subnet that you want to apply to this cluster. ElastiCache provides a default IPv4 subnet group or you can choose to create a new one. For IPv6, you need to create a subnet group with an IPv6 CIDR block. If you choose dual stack, you then must select a Discovery IP type, either IPv6 or IPv4.

   For more information see, Create a subnet in your VPC.

7. For Availability zone placements, you have two options:

   • No preference – ElastiCache chooses the Availability Zone.

   • Specify availability zones – You specify the Availability Zone for each cluster.

     If you chose to specify the Availability Zones, for each cluster in each shard, choose the Availability Zone from the list.

   For more information, see Choosing regions and availability zones.

   

   Specifying Keyspaces and Availability Zones

8. Choose Next

9. Under Advanced Redis settings

   1. For Security:

      1. To encrypt your data, you have the following options:

         • Encryption at rest – Enables encryption of data stored on disk. For more information, see Encryption at Rest.

           Note

           You have the option to supply a different encryption key by choosing Customer Managed Amazon KMS key and choosing the key. For more information, see Using customer managed keys from Amazon KMS.

         • Encryption in-transit – Enables encryption of data on the wire. For more information, see encryption in transit. For Redis engine version 6.0 and above, if you enable Encryption in-transit you will be prompted to specify one of the following Access Control options:

           • No Access Control – This is the default setting. This indicates no restrictions on user access to the cluster.

           • User Group Access Control List – Select a user group with a defined set of users that can access the cluster. For more information, see Managing User Groups with the Console and CLI.

           • Redis AUTH Default User – An authentication mechanism for Redis server. For more information, see Redis AUTH.

         • Redis AUTH – An authentication mechanism for Redis server. For more information, see Redis AUTH.

         Note

         For Redis versions between 3.2.6 onward, excluding version 3.2.10, Redis AUTH is the sole option.

      2. For Security groups, choose the security groups that you want for this cluster. A security group acts as a firewall to control network access to your cluster. You can use the default security group for your VPC or create a new one.

         For more information on security groups, see Security groups for your VPC in the Amazon VPC User Guide.

10. For regularly scheduled automatic backups, select Enable automatic backups and then enter the number of days that you want each automatic backup retained before it is automatically deleted. If you don't want regularly scheduled automatic backups, clear the Enable automatic backups check box. In either case, you always have the option to create manual backups.

    For more information on Redis backup and restore, see Snapshot and restore.

11. (Optional) Specify a maintenance window. The maintenance window is the time, generally an hour in length, each week when ElastiCache schedules system maintenance for your cluster. You can allow ElastiCache to choose the day and time for your maintenance window (No preference), or you can choose the day, time, and duration yourself (Specify maintenance window). If you choose Specify maintenance window from the lists, choose the Start day, Start time, and Duration (in hours) for your maintenance window. All times are UCT times.

    For more information, see Managing maintenance.

12. (Optional) For Logs:

    • Under Log format, choose either Text or JSON.

    • Under Destination Type, choose either CloudWatch Logs or Kinesis Firehose.

    • Under Log destination, choose either Create new and enter either your CloudWatch Logs log group name or your Firehose stream name, or choose Select existing and then choose either your CloudWatch Logs log group name or your Firehose stream name,

13. For Tags, to help you manage your clusters and other ElastiCache resources, you can assign your own metadata to each resource in the form of tags. For mor information, see Tagging your ElastiCache resources.

14. Review all your entries and choices, then make any needed corrections. When you're ready, choose Next.

15. After you have configured the cluster in the previous steps, you now configure your secondary cluster details..

16. Under Regional cluster, choose the Amazon Region where th cluster is located.

17. Under Cluster info, enter a name and optional description of the cluster.

18. The following options are prepopulated to match the primary cluster configuration and cannot be changed:

    • Location

    • Engine version

    • Instance type

    • Node type

    • Number of shards

    • Parameter group

      Note

      ElastiCache autogenerates a new parameter group from values of the provided parameter group and applies the new parameter group to the cluster. Use this new parameter group to modify parameters on a global datastore. Each autogenerated parameter group is associated with one and only one cluster and, therefore, only one global datastore.

    • Encryption at rest – Enables encryption of data stored on disk. For more information, see Encryption at rest.

      Note

      You can supply a different encryption key by choosing Customer Managed Amazon KMS key and choosing the key. For more information, see Using Customer Managed Amazon KMS keys.

    • Encryption in-transit – Enables encryption of data on the wire. For more information, see Encryption in transit. For Redis engine version 6.4 and above, if you enable encryption in-transit you are prompted to specify one of the following Access Control options:

      • No Access Control – This is the default setting. This indicates no restrictions on user access to the cluster.

      • User Group Access Control List – Choose a user group with a defined set of users that can access the cluster. For more information, see Managing User Groups with the Console and CLI.

      • Redis AUTH Default User – An authentication mechanism for Redis server. For more information, see Redis AUTH.

    Note

    For Redis versions between 4.0.2, when Encryption in-transit was first supported, and 6.0.4, Redis AUTH is the sole option.

    The remaining secondary cluster settings are pre-populated with the same values as the primary cluster, but the following can be updated to meet specific requirements for that cluster:

    • Port

    • Number of replicas

    • Subnet group

    • Preferred Availability Zone(s)

    • Security groups

    • Customer Managed (Amazon KMS key)

    • Redis AUTH Token

    • Enable automatic backups

    • Backup retention period

    • Backup window

    • Maintenance window

    • Topic for SNS notification

19. Choose Create. This sets the status of the global datastore to Creating. After the primary cluster and secondary clusters are associated with the global datastore, the status changes to Available. You have a primary cluster that accepts reads and writes and a secondary cluster that accepts reads replicated from the primary cluster.

    The Redis page is also updated to indicate whether a cluster is part of a global datastore, including the following:

    • Global Datastore – The name of the global datastore to which the cluster belongs.

    • Global Datastore Role – The role of the cluster, either primary or secondary.

To view global datastore details

1. Sign in to the Amazon Web Services Management Console and open the ElastiCache console at https://console.amazonaws.cn/elasticache/.

2. On the navigation pane, choose Global Datastore and then choose an available global datastore.

To add an Amazon Region to a global datastore

1. Sign in to the Amazon Web Services Management Console and open the ElastiCache console at https://console.amazonaws.cn/elasticache/.

2. On the navigation pane, choose Global Datastore, and then for Global Datastore Name choose a global datastore.

3. Choose Add Region, and choose the Amazon Region where the secondary cluster is to reside.

4. Under Redis settings, enter a value for Name and, optionally, for Description for the cluster.

5. Keep the following options as they are. They're prepopulated to match the primary cluster configuration, and you can't change them.

   • Engine version

   • Instance type

   • Node type

   • Number of shards

   • Parameter group

     Note

     ElastiCache autogenerates a new parameter group from values of the provided parameter group and applies the new parameter group to the cluster. Use this new parameter group to modify parameters on a global datastore. Each autogenerated parameter group is associated with one and only one cluster and, therefore, only one global datastore.

   • Encryption at rest

     Note

     You can supply a different encryption key by choosing Customer Managed Amazon KMS key and choosing the key.

   • Encryption in transit

   • Redis AUTH

6. (Optional) Update the remaining secondary cluster settings. These are prepopulated with the same values as the primary cluster, but you can update them to meet specific requirements for that cluster:

   • Port

   • Number of replicas

   • Subnet group

   • Preferred Availability Zone(s)

   • Security groups

   • Customer Managed Amazon KMS key)

   • Redis AUTH Token

   • Enable automatic backups

   • Backup retention period

   • Backup window

   • Maintenance window

   • Topic for SNS notification

7. Choose Add.

To modify a global datastore

1. Sign in to the Amazon Web Services Management Console and open the ElastiCache console at https://console.amazonaws.cn/elasticache/.

2. On the navigation pane, choose Global Datastore, and then for Global Datastore Name, choose a global datastore.

3. Choose Modify and choose among the following options:

   • Modify description – Update the description of the global datastore

   • Modify engine version – Only Redis engine version 5.0.6 or later is available.

   • Modify node type – Scale regional clusters both vertically (scaling up and down) and horizontally (scaling in and out). Options include the R5 and M5 node families. For more information on node types, see Supported node types.

   • Modify Automatic Failover – Enable or disable Automatic Failover. When you enable failover and primary nodes in regional clusters shut down unexpectedly, ElastiCache fails over to one of the regional replicas. For more information, see Auto failover.

   For Redis clusters with cluster-mode enabled:

   • Add shards – Enter the number of shards to add and optionally specify one or more Availability Zones.

   • Delete shards – Choose shards to be deleted in each Amazon Region.

   • Rebalance shards – Rebalance the slot distribution to ensure uniform distribution across existing shards in the cluster.

To promote a secondary cluster to primary

1. Sign in to the Amazon Web Services Management Console and open the ElastiCache console at https://console.amazonaws.cn/elasticache/.

2. On the navigation pane, choose Global Datastore under Redis.

3. Choose the global datastore name to view the details.

4. Choose the Secondary cluster.

5. Choose Promote to primary.

   You're then prompted to confirm your decision with the following warning: Promoting a region to primary will make the cluster in this region as read/writable. Are you sure you want to promote the secondary cluster to primary?

   The current primary cluster in primary region will become secondary and will stop accepting writes after this operation completes. Please ensure you update your application stack to direct traffic to the new primary region.

6. Choose Confirm if you want to continue the promotion or Cancel if you don't.

To remove an Amazon Region from a global datastore

1. Sign in to the Amazon Web Services Management Console and open the ElastiCache console at https://console.amazonaws.cn/elasticache/.

2. On the navigation pane, choose Global Datastore under Redis.

3. Choose a global datastore.

4. Choose the Region you want to remove.

5. Choose Remove region.

   Note

   This option is only available for secondary clusters.

   You're then be prompted to confirm your decision with the following warning: Removing the region will remove your only available cross region replica for the primary cluster. Your primary cluster will no longer be set up for disaster recovery and improved read latency in remote region. Are you sure you want to remove the selected region from the global datastore?

6. Choose Confirm if you want to continue the promotion or Cancel if you don't.

To delete a global datastore

1. Sign in to the Amazon Web Services Management Console and open the ElastiCache console at https://console.amazonaws.cn/elasticache/.

2. On the navigation pane, choose Global Datastore under Redis.

3. Under Global Datastore Name choose the global datastore you want to delete and then choose Delete.

   You're then be prompted to confirm your decision with the following warning: Are you sure you want to delete this Global Datastore?

4. Choose Delete.