Manage Redis AUTH

Note: If you are looking for the Memorystore for Redis Cluster documentation, see Manage IAM authentication.

This page gives instructions on common tasks for the Redis AUTH feature on Memorystore for Redis. For details on what the AUTH feature provides, see AUTH feature overview.

For a list of permissions a user needs in order to perform the AUTH tasks on this page, see Redis AUTH permissions.

Creating a Redis instance with AUTH enabled

Console

When you create a Redis instance, select Enable AUTH .

gcloud

Enter the following command, replacing variables with appropriate values:

gcloud redis instances create instance-id --enable-auth --size=size --region=region --zone=zone --redis-version=version

Enabling/disabling AUTH on an existing Redis instance

Note: AUTH string credentials are not confidential when transmitted. See AUTH feature overview for more details.

Console

1. Go to the Memorystore for Redis page in the Google Cloud console.

   Memorystore for Redis

2. View your instance's Instance details page by clicking on your Instance ID.

3. Click the Edit button.

4. Find the AUTH section.

   • If you want to enable AUTH, select checkbox labeled Enable AUTH.

   • If you want to disable AUTH, deselect the checkbox labeled Enable AUTH.

5. Click the Save button.

gcloud

1. Enable AUTH for your instance by running the following command, replacing variables with appropriate values:

   gcloud redis instances update instance-id --enable-auth --region=region
   

2. Disable AUTH for your instance by running the following command, replacing variables with appropriate values:

   gcloud redis instances update instance-id --no-enable-auth --region=region
   

Getting the AUTH string

Console

1. Go to the Memorystore for Redis page in the Google Cloud console.

   Memorystore for Redis

2. View your instance's Instance details page by clicking on your Instance ID.

3. Find the AUTH string value in the Security section.

gcloud

1. Get the AUTH string by copying it from the response body returned by the following command:

   gcloud redis instances get-auth-string instance-id --region=region
   

Changing the AUTH string

Follow the steps below to change the AUTH string to a new value:

1. Disable AUTH:

   gcloud redis instances update instance-id --no-enable-auth --region=region
   

2. Enable AUTH:

   gcloud redis instances update instance-id --enable-auth --region=region
   

   Note: This step interrupts your client's authenticated connection because a new AUTH string is generated, invalidating the previous AUTH string.

3. Get the new AUTH string:

   gcloud redis instances get-auth-string instance-id --region=region
   

4. In your application, replace the old AUTH string with the new AUTH string and reconnect your client.

Connecting to a Redis instance with AUTH

To use AUTH and redis-cli to connect to your instance, see Connecting to a Redis instance that uses AUTH.

What's next

• View the AUTH feature overview.