Модуль google.cloud.gcp_alloydb_cluster — создает ресурс GCP Alloydb.Cluster

access_token

string

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

annotations

dictionary

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

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

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

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

auth_kind

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

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

Варианты:

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

automated_backup_policy

dictionary

Политика автоматического резервного копирования для этого кластера.

По умолчанию AutomatedBackupPolicy отключена.

backup_window

string

Продолжительность временного окна, в течение которого можно создать резервную копию.

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

Продолжительность окна резервного копирования должна составлять не менее 5 минут.

Верхний предел продолжительности окна не установлен.

Если значение не задано, по умолчанию используется 1 час.

Длительность в секундах с точностью до девяти знаков после запятой, оканчивающаяся на ‘s’.

Пример: “3.5s”.

enabled

boolean

Включено ли автоматическое резервное копирование.

Варианты:

• false
• true

encryption_config

dictionary

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

kms_key_name

string

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

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

labels

dictionary

Метки, которые будут применяться к резервным копиям, созданным с помощью этой конфигурации.

location

string

Место хранения резервной копии.

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

quantity_based_retention

dictionary

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

Несовместима с ‘time_based_retention’: нельзя задать оба параметра одновременно.

count

integer

Количество резервных копий, которые нужно хранить.

time_based_retention

dictionary

Политика хранения резервных копий на основе времени.

Несовместима с ‘quantity_based_retention’: нельзя задать оба параметра одновременно.

retention_period

string

Период хранения.

Длительность в секундах с точностью до девяти знаков после запятой, оканчивающаяся на ‘s’.

Пример: “3.5s”.

weekly_schedule

dictionary

Еженедельное расписание резервного копирования.

days_of_week

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

Дни недели, в которые нужно создавать резервную копию.

Необходимо указать как минимум один день недели.

start_times

list / элементы=dictionary / обязательно

Время начала резервного копирования в течение дня.

Необходимо указать как минимум одно время начала.

Предполагается, что время начала задано в UTC и соответствует ровному часу (например, 04:00:00).

hours

integer

Часы суток в 24-часовом формате.

Значение должно быть от 0 до 23.

API может разрешать значение «24:00:00» для таких ситуаций, как время закрытия предприятия.

minutes

integer

Минуты часа суток.

В настоящее время поддерживается только значение 0.

nanos

integer

Доли секунды в наносекундах.

В настоящее время поддерживается только значение 0.

seconds

integer

Секунды минуты.

В настоящее время поддерживается только значение 0.

cluster_id

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

Идентификатор кластера AlloyDB.

cluster_type

string

Тип кластера.

Если значение не задано, по умолчанию используется PRIMARY.

Варианты:

• "PRIMARY" ← (по умолчанию)
• "SECONDARY"

continuous_backup_config

dictionary

Конфигурация непрерывного резервного копирования для этого кластера.

Если политика не указана, будет использоваться политика по умолчанию.

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

enabled

boolean

Включено ли восстановление из непрерывных резервных копий.

Если значение не задано, по умолчанию используется true.

Варианты:

• false
• true ← (по умолчанию)

encryption_config

dictionary

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

kms_key_name

string

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

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

recovery_window_days

integer

Количество дней, за которые можно выполнить восстановление с помощью PITR.

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

Если значение не задано, по умолчанию используется 14 дней.

database_version

string

Основная версия ядра базы данных.

Это необязательное поле, которое заполняется при создании кластера.

Примечание: изменение этого поля на более высокую версию приводит к обновлению кластера AlloyDB; это изменение необратимо.

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.

etag

string

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

initial_user

dictionary

Начальная настройка пользователя при создании кластера.

password

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

Начальный пароль пользователя.

user

string

Имя пользователя базы данных.

labels

dictionary

Задаваемые пользователем метки кластера AlloyDB.

location

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

Место размещения кластера AlloyDB.

maintenance_update_policy

dictionary

MaintenanceUpdatePolicy определяет политику обновления системы.

maintenance_windows

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

Предпочтительное время для проведения обслуживания.

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

day

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

Предпочтительный день недели для обслуживания, например:

MONDAY, TUESDAY и т. д.

Варианты:

• "MONDAY"
• "TUESDAY"
• "WEDNESDAY"
• "THURSDAY"
• "FRIDAY"
• "SATURDAY"
• "SUNDAY"

start_time

dictionary / обязательно

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

Обслуживание начнется в течение часа после этого времени.

hours

integer / обязательно

Часы суток в 24-часовом формате.

Значение должно быть от 0 до 23.

minutes

integer

Минуты часа суток.

В настоящее время поддерживается только значение 0.

nanos

integer

Доли секунды в наносекундах.

В настоящее время поддерживается только значение 0.

seconds

integer

Секунды минуты.

В настоящее время поддерживается только значение 0.

network_config

dictionary

Метаданные, связанные с конфигурацией сети.

allocated_ip_range

string

Имя выделенного диапазона IP-адресов для кластера AlloyDB с частным IP-адресом.

Например: “google-managed-services-default”.

Если задано, IP-адреса экземпляров этого кластера будут выделены из указанного диапазона.

network

string

Ссылка на ресурс сети VPC, в которой создаются ресурсы кластера и из которой к ним можно получить доступ через частный IP-адрес.

Сеть должна принадлежать тому же проекту, что и кластер.

Указывается в формате: “projects/{projectNumber}/global/networks/{network_id}”.

project

string

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

psc_config

dictionary

Конфигурация Private Service Connect (PSC) для кластера.

psc_enabled

boolean

Создать экземпляр, допускающий подключения к нему из конечных точек Private Service Connect.

Варианты:

• false
• true

service_owned_project_number

integer

Номер проекта, который необходимо внести в список разрешенных в сетевом подключении для включения исходящего соединения, если для сетевого подключения настроен режим ACCEPT_MANUAL.

Если для сетевого подключения настроен режим ACCEPT_AUTOMATIC, этот номер проекта не требуется явно вносить в список разрешенных.

restore_backup_source

dictionary

Источник для восстановления из резервной копии.

Несовместим с ‘restore_continuous_backup_source’: нельзя задать оба параметра одновременно.

backup_name

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

Имя резервной копии, из которой восстанавливается этот кластер.

restore_continuous_backup_source

dictionary

Источник для восстановления на момент времени (PITR).

Несовместим с ‘restore_backup_source’: нельзя задать оба параметра одновременно.

cluster

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

Имя исходного кластера, из которого восстанавливается этот кластер.

point_in_time

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

Момент времени, на который восстанавливается этот кластер, в формате RFC 3339.

scopes

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

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

secondary_config

dictionary

Конфигурация вторичного кластера для репликации между регионами.

Этот параметр следует задавать только в том случае, если тип кластера — SECONDARY.

primary_cluster_name

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

Имя первичного кластера должно иметь формат ‘projects/{project}/locations/{location}/clusters/{cluster_id}’.

service_account_contents

jsonarg

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

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

service_account_email

string

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

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

service_account_file

path

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

выбрано serviceaccount.

state

string

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

Варианты:

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

subscription_type

string

Тип подписки кластера.

Варианты:

• "TRIAL"
• "STANDARD"

backupSource

dictionary

Кластер, созданный из резервной копии.

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

backupName

string

Имя ресурса резервной копии.

Возвращается: если задано

changed

boolean

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

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

continuousBackupInfo

dictionary

ContinuousBackupInfo содержит сведения о свойствах непрерывного резервного копирования кластера.

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

earliestRestorableTime

string

Самый ранний момент времени, на который можно выполнить восстановление.

Поле только для вывода.

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

enabledTime

string

Время последнего включения ContinuousBackup.

Значение равно null, если ContinuousBackup не включено.

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

encryptionInfo

dictionary

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

Сведения о шифровании WAL и резервных копий, необходимых для ContinuousBackup.

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

encryptionType

string

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

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

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

kmsKeyVersions

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

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

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

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

schedule

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

Дни недели, в которые создается непрерывная резервная копия.

Поле только для вывода.

Игнорируется, если передано в запросе.

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

encryptionInfo

dictionary

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

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

encryptionType

string

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

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

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

kmsKeyVersions

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

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

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

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

migrationSource

dictionary

Кластер, созданный в результате миграции DMS.

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

hostPort

string

Имя хоста и порт локального экземпляра в формате host:port.

Возвращается: если задано

referenceId

string

Заполнитель для внешнего идентификатора источника (например, имени задания DMS), создавшего кластер.

Возвращается: если задано

sourceType

string

Тип источника миграции.

Возвращается: если задано

name

string

Имя ресурса кластера.

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

reconciling

boolean

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

Согласование (https://google.aip.dev/128#reconciliation).

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

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

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

state

string

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

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

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

trialMetadata

dictionary

Содержит информацию и все метаданные, связанные с пробными кластерами TRIAL.

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

endTime

string

Время окончания пробного кластера.

Возвращается: если задано

graceEndTime

string

Время окончания льготного периода пробного кластера.

Возвращается: если задано

startTime

string

Время запуска пробного кластера.

Возвращается: если задано

upgradeTime

string

Время обновления пробного кластера до стандартного кластера.

Возвращается: если задано

uid

string

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

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