instances_auth_string

Creates, updates, deletes, gets or lists an instances_auth_string resource.

Overview

Name	instances_auth_string
Type	Resource
Id	google.redis.instances_auth_string

Fields

The following fields are returned by SELECT queries:

get_auth_string

Name	Datatype	Description
authString	string	AUTH string set on the instance.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_auth_string	select	projectsId, locationsId, instancesId		Gets the AUTH string for a Redis instance. If AUTH is not enabled for the instance the response will be empty. This information is not included in the details returned to GetInstance.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
instancesId	string
locationsId	string
projectsId	string

SELECT examples

get_auth_string

Gets the AUTH string for a Redis instance. If AUTH is not enabled for the instance the response will be empty. This information is not included in the details returned to GetInstance.

SELECT
authString
FROM google.redis.instances_auth_string
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required
;