модуль google.cloud.gcp_alloydb_user — создание ресурса GCP Alloydb.User

Примечание

Этот модуль входит в коллекцию google.cloud (версия 1.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Для работы с этим модулем нужны дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_alloydb_user.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Пользователь базы данных в кластере AlloyDB.

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

python >= 3.8
requests >= 2.18.4
google-auth >= 2.25.1

Параметры

Параметр	Комментарии
access_token string	Токен доступа для аутентификации.
auth_kind string / обязательный	Тип используемых учетных данных. Варианты: `"accesstoken"` `"application"` `"machineaccount"` `"serviceaccount"`
cluster dictionary / обязательный	Идентифицирует кластер AlloyDB. Должен иметь формат ‘projects/{project}/locations/{location}/clusters/{cluster_id}’. Это поле является ссылкой на ресурс Cluster в GCP. Его можно указать двумя способами: во-первых, можно задать словарь с ключом ‘name’, соответствующим вашему ресурсу. Также можно добавить `register: name-of-resource` в задачу Cluster, а затем задать для этого поля значение `{{ name-of-resource }}`.
database_roles list / elements=string	Список ролей базы данных, назначенных этому пользователю базы данных.
env_type string	Указывает среду Ansible, в которой выполняется этот модуль. Не задавайте это поле, если не знаете, что делаете. Оно изменяет только строку User Agent для запросов API.
password string	Пароль этого пользователя базы данных.
project string	Проект Google Cloud Platform, который следует использовать.
scopes list / elements=string	Массив используемых областей доступа.
service_account_contents jsonarg	Содержимое JSON-файла учетной записи службы — в виде словаря или JSON-строки, представляющей его.
service_account_email string	Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес электронной почты по умолчанию.
service_account_file path	Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount.
state string	Должен ли ресурс существовать в GCP. Варианты: `"present"` ← (по умолчанию) `"absent"`
user_id string / обязательный	Имя роли базы данных для пользователя.
user_type string / обязательный	Тип этого пользователя. Варианты: `"ALLOYDB_BUILT_IN"` `"ALLOYDB_IAM_USER"`

Примечания

Примечание

Справочник API: https://cloud.google.com/alloydb/docs/reference/rest/v1/projects.locations.clusters.users/create
Руководство по AlloyDB: https://cloud.google.com/alloydb/docs/
Для аутентификации параметру auth_kind можно задать значение с помощью переменной среды GCP_AUTH_KIND.
Для аутентификации параметру service_account_file можно задать значение с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
Для аутентификации параметру service_account_contents можно задать значение с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
Для аутентификации параметру service_account_email можно задать значение с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации параметру access_token можно задать значение с помощью переменной среды GCP_ACCESS_TOKEN.
Для аутентификации параметру scopes можно задать значение с помощью переменной среды GCP_SCOPES.
Значения переменных среды используются только в том случае, если значения не заданы в плейбуке.
Параметры service_account_email, service_account_file, service_account_file и access_token являются взаимоисключающими.

Примеры

- name: Create user for cluster
  google.cloud.gcp_alloydb_user:
    user_id: superuser
    state: present
    user_type: ALLOYDB_BUILT_IN
    password: Test123Test
    database_roles:
      - alloydbsuperuser
    cluster:
      name: projects/my-project/locations/us-central1/clusters/my-cluster

Возвращаемые значения

Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
changed boolean	Изменился ли ресурс. Возвращается: всегда
name string	Имя ресурса в формате projects/{project}/locations/{location}/clusters/{cluster}/users/{user}. Возвращается: при успехе
state string	Текущее состояние ресурса. Возвращается: всегда

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_alloydb_user_module.html