Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_alloydb_backup — создание ресурса GCP Alloydb.Backup

Примечание

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

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

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

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

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Резервная копия AlloyDB.

Требования

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

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

Параметры

Параметр

Комментарии

access_token

string

Токен доступа, используемый для аутентификации.

annotations

dictionary

Аннотации, позволяющие клиентским инструментам хранить небольшие объемы произвольных данных.

Они отличаются от меток.

https://google.aip.dev/128 Объект, содержащий список пар «ключ»: значение.

Пример: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

auth_kind

string / обязательный

Тип используемых учетных данных.

Варианты:

  • "accesstoken"
  • "application"
  • "machineaccount"
  • "serviceaccount"

backup_id

string / обязательный

Идентификатор резервной копии AlloyDB.

cluster_name

string / обязательный

Полное имя ресурса исходного кластера резервной копии (например, projects/{project}/locations/{location}/clusters/{clusterId}).

description

string

Описание резервной копии, заданное пользователем.

display_name

string

Задаваемое пользователем понятное отображаемое имя резервной копии.

encryption_config

dictionary

EncryptionConfig описывает конфигурацию шифрования кластера или резервной копии, зашифрованной с помощью CMEK (ключа шифрования, управляемого клиентом).

kms_key_name

string

Полное имя ресурса ключа KMS.

Каждый ключ Cloud KMS привязан к региону и имеет следующий формат: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

env_type

string

Указывает среду Ansible, в которой выполняется этот модуль.

Не задавайте это значение, если не знаете, что делаете.

Оно изменяет только строку User Agent для запросов API.

labels

dictionary

Метки резервной копии AlloyDB, заданные пользователем.

Объект, содержащий список пар «ключ»: значение.

Пример: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

location

string / обязательный

Местоположение, в котором должна храниться резервная копия AlloyDB.

project

string

Проект Google Cloud Platform, который следует использовать.

scopes

list / элементы=string

Массив используемых областей доступа.

service_account_contents

jsonarg

Содержимое JSON-файла учетной записи службы

в виде словаря или JSON-строки, представляющей его.

service_account_email

string

Необязательный адрес электронной почты учетной записи службы, если выбрана machineaccount

и пользователь не хочет использовать адрес электронной почты по умолчанию.

service_account_file

path

Путь к JSON-файлу учетной записи службы, если в качестве типа выбрана

serviceaccount.

state

string

Должен ли ресурс существовать в GCP.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

type

string

Тип резервной копии, указывающий причину ее создания.

Варианты:

  • "TYPE_UNSPECIFIED"
  • "ON_DEMAND"
  • "AUTOMATED"
  • "CONTINUOUS"

Примечания

Примечание

  • Справочник API: https://cloud.google.com/alloydb/docs/reference/rest/v1/projects.locations.backups/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 an on-demand backup for a cluster
  google.cloud.gcp_alloydb_backup:
    backup_id: my-backup
    state: present
    cluster_name: projects/my-project/locations/us-central1/clusters/my-cluster
    type: ON_DEMAND
    location: us-central1

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

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

Ключ

Описание

changed

boolean

Был ли изменен ресурс.

Возвращается: всегда

clusterUid

string

Только для вывода.

UID кластера, автоматически созданный системой и использованный для создания этого ресурса.

Возвращается: при успешном выполнении

createTime

string

Только для вывода.

Временная метка создания.

Временная метка в формате RFC3339 UTC «Zulu» с наносекундной точностью и не более чем девятью десятичными знаками.

Примеры: “2014-10-02T15:01:23Z” и “2014-10-02T15:01:23.045123456Z”.

Возвращается: при успешном выполнении

deleteTime

string

Только для вывода.

Временная метка удаления.

Временная метка в формате RFC3339 UTC «Zulu» с наносекундной точностью и не более чем девятью десятичными знаками.

Примеры: “2014-10-02T15:01:23Z” и “2014-10-02T15:01:23.045123456Z”.

Возвращается: при успешном выполнении

encryptionInfo

dictionary

EncryptionInfo содержит сведения о шифровании кластера или резервной копии.

Возвращается: при успешном выполнении

encryptionType

string

Только для вывода.

Тип шифрования.

Возвращается: при успешном выполнении

kmsKeyVersions

list / элементы=string

Только для вывода.

Версии ключей Cloud KMS, используемые для защиты базы данных или резервной копии.

Возвращается: при успешном выполнении

etag

string

Для проверки актуальности ресурса (https://google.aip.dev/154).

Возвращается: при успешном выполнении

expiryQuantity

dictionary

Только для вывода.

Срок хранения резервной копии, заданный политикой хранения и выраженный количеством.

Когда срок хранения, выраженный количеством, истекает, резервная копия может быть удалена сборщиком мусора.

Возвращается: при успешном выполнении

retentionCount

integer

Только для вывода.

Позиция резервной копии среди резервных копий того же исходного кластера и типа, упорядоченных по времени создания в обратном хронологическом порядке (т. е.

сначала самые новые).

Возвращается: при успешном выполнении

totalRetentionCount

integer

Только для вывода.

Размер очереди, основанной на количестве, заданный политикой хранения резервных копий.

Возвращается: при успешном выполнении

expiryTime

string

Только для вывода.

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

Оно определяется длительностью, заданной политикой хранения резервных копий, добавленной к createTime резервной копии.

Возвращается: при успешном выполнении

name

string

Только для вывода.

Имя ресурса резервной копии в формате: * projects/{project}/locations/{region}/backups/{backupId}.

Возвращается: при успешном выполнении

reconciling

boolean

Только для вывода.

Сверка (https://google.aip.dev/128#reconciliation); значение true означает, что служба активно обновляет ресурс.

Это может происходить из-за обновлений, инициированных пользователем, или действий системы, таких как переключение при сбое или обслуживание.

Возвращается: при успешном выполнении

sizeBytes

string

Только для вывода.

Размер резервной копии в байтах.

Возвращается: при успешном выполнении

state

string

Только для вывода.

Текущее состояние резервной копии.

Возвращается: при успешном выполнении

uid

string

Только для вывода.

UID ресурса, автоматически созданный системой.

UID назначается при создании ресурса и сохраняется до его удаления.

Возвращается: при успешном выполнении

updateTime

string

Только для вывода.

Временная метка обновления.

Временная метка в формате RFC3339 UTC «Zulu» с наносекундной точностью и не более чем девятью десятичными знаками.

Примеры: “2014-10-02T15:01:23Z” и “2014-10-02T15:01:23.045123456Z”.

Возвращается: при успешном выполнении

Авторы

  • 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_backup_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API