модуль google.cloud.gcp_alloydb_instance – создает ресурс GCP Alloydb.Instance

access_token

string

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

activation_policy

string

«Указывает, нужно ли запускать экземпляр.

После активации экземпляра политику активации можно изменить на `NEVER`, чтобы остановить экземпляр.

Аналогичным образом политику активации можно изменить на `ALWAYS`, чтобы запустить экземпляр.

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

Подробнее см. в документации API.

Возможные значения: `ACTIVATION_POLICY_UNSPECIFIED`, `ALWAYS`, `NEVER`.».

Варианты:

• "ACTIVATION_POLICY_UNSPECIFIED"
• "ALWAYS"
• "NEVER"

annotations

dictionary

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

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

auth_kind

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

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

Варианты:

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

availability_type

string

«Тип доступности экземпляра.

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

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

Основные экземпляры могут быть ZONAL или REGIONAL.

Экземпляры пула чтения также могут быть ZONAL или REGIONAL.

Пулы чтения размером 1 могут иметь только зональную доступность.

Пулы чтения с количеством узлов 2 или более могут иметь региональную доступность (узлы размещаются в 2 или более зонах региона).

Возможные значения: `AVAILABILITY_TYPE_UNSPECIFIED`, `ZONAL`, `REGIONAL`.».

Варианты:

• "AVAILABILITY_TYPE_UNSPECIFIED"
• "ZONAL"
• "REGIONAL"

client_connection_config

dictionary

Параметры конфигурации клиентского подключения.

require_connectors

boolean

Настройка, разрешающая подключение к базе данных только через коннекторы (например, AuthProxy).

Варианты:

• false
• true

ssl_config

dictionary

Параметры SSL для этого экземпляра.

ssl_mode

string

Режим SSL.

Определяет поведение SSL/TLS-подключения между клиентом и сервером.

Варианты:

• "ENCRYPTED_ONLY"
• "ALLOW_UNENCRYPTED_AND_ENCRYPTED"

cluster

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

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

Должно иметь формат ‘projects/{project}/locations/{location}/clusters/{cluster_id}’.

Это поле является ссылкой на ресурс Cluster в GCP.

Его можно указать двумя способами: во-первых, можно поместить словарь с ключом ‘name’, соответствующим вашему ресурсу.

В качестве альтернативы можно добавить `register: name-of-resource` в задачу Cluster, а затем присвоить этому полю значение `{{ name-of-resource }}`.

database_flags

dictionary

Флаги базы данных.

Задаются на уровне экземпляра.

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

* Для экземпляров чтения можно задать новые флаги или переопределить существующие флаги, относящиеся к чтению, например

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

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

display_name

string

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

env_type

string

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

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

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

gce_zone

string

Зона Compute Engine, в которой должен обслуживаться экземпляр, согласно https://cloud.google.com/compute/docs/regions-zones. Это значение можно указать ТОЛЬКО для экземпляров ZONAL.

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

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

instance_id

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

Идентификатор экземпляра AlloyDB.

instance_type

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

Тип экземпляра.

Если тип экземпляра — SECONDARY, укажите cluster_type соответствующего вторичного кластера, а не SECONDARY.

Варианты:

• "PRIMARY"
• "READ_POOL"
• "SECONDARY"

labels

dictionary

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

machine_config

dictionary

Конфигурация машин, на которых работает базовый движок базы данных.

cpu_count

integer

Количество процессоров в экземпляре виртуальной машины.

machine_type

string

Тип машины экземпляра виртуальной машины.

Например:

“n2-highmem-4”, “n2-highmem-8”, “c4a-highmem-4-lssd”.

Значение `cpu_count` должно совпадать с количеством виртуальных ЦП для этого типа машины.

network_config

dictionary

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

authorized_external_networks

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

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

Это поле можно задать только в том случае, если для `enable_public_ip` установлено значение true.

cidr_range

string

Диапазон CIDR для одной разрешенной сети экземпляра.

enable_outbound_public_ip

boolean

Включение исходящего общедоступного IP-адреса для экземпляра.

Варианты:

• false
• true

enable_public_ip

boolean

Включение общедоступного IP-адреса для экземпляра.

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

Варианты:

• false
• true

observability_config

dictionary

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

assistive_experiences_enabled

boolean

Указывает, включены ли вспомогательные функции для этого экземпляра AlloyDB.

Варианты:

• false
• true

enabled

boolean

Состояние функций наблюдаемости для экземпляра.

Варианты:

• false
• true

max_query_string_length

integer

Длина строки запроса.

Значение по умолчанию — 10240.

Допустимым считается любое целое число от 1024 до 100000.

preserve_comments

boolean

Сохранять комментарии в строке запроса.

Варианты:

• false
• true

query_plans_per_minute

integer

Количество планов выполнения запросов, собираемых Insights в минуту для всех запросов вместе.

Значение по умолчанию — 5.

Допустимым считается любое целое число от 0 до 200.

record_application_tags

boolean

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

По умолчанию этот флаг включен.

Варианты:

• false
• true

track_active_queries

boolean

Отслеживать выполняющиеся запросы.

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

Варианты:

• false
• true

track_wait_event_types

boolean

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

Варианты:

• false
• true

track_wait_events

boolean

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

Варианты:

• false
• true

project

string

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

psc_instance_config

dictionary

Конфигурация Private Service Connect (PSC) для экземпляра.

allowed_consumer_projects

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

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

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

psc_auto_connections

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

Конфигурация автоматизации службы PSC.

consumer_network

string

Сеть-потребитель для автоматизации службы PSC, например: “projects/vpc-host-project/global/networks/default”.

Сеть-потребитель может размещаться в проекте, отличном от проекта-потребителя.

API ожидает, что проект-потребитель будет указан по идентификатору проекта (а не по номеру проекта).

consumer_network_status

string

Состояние политики подключения службы.

consumer_project

string

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

API ожидает, что проект-потребитель будет указан по идентификатору проекта (а не по номеру проекта).

ip_address

string

IP-адрес конечной точки автоматизации службы PSC.

status

string

Состояние подключения автоматизации службы PSC.

psc_dns_name

string

DNS-имя экземпляра для подключения через PSC.

Формат имени: <uid>.<uid>.<region>.alloydb-psc.goog.

psc_interface_configs

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

Конфигурация интерфейсов PSC, подключенных к экземпляру и используемых для исходящих подключений.

В настоящее время AlloyDB поддерживает не более одного интерфейса PSC.

network_attachment_resource

string

Ресурс сетевого подключения, созданный в проекте-потребителе, к которому будет подключен интерфейс PSC.

Формат: “projects/${CONSUMER_PROJECT}/regions/${REGION}/networkAttachments/${NETWORK_ATTACHMENT_NAME}”.

Сетевое подключение должно находиться в том же регионе, что и экземпляр.

service_attachment_link

string

Подключение службы, созданное при включении Private Service Connect (PSC) для экземпляра.

Имя ресурса имеет формат `projects/<alloydb-tenant-project-number>/regions/<region-name>/serviceAttachments/<service-attachment-name>`.

query_insights_config

dictionary

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

query_plans_per_minute

integer

Количество планов выполнения запросов, собираемых Insights в минуту для всех запросов вместе.

Значение по умолчанию — 5.

Допустимым считается любое целое число от 0 до 20.

query_string_length

integer

Длина строки запроса.

Значение по умолчанию — 1024.

Допустимым считается любое целое число от 256 до 4500.

record_application_tags

boolean

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

По умолчанию этот флаг включен.

Варианты:

• false
• true

record_client_address

boolean

Записывать адрес клиента для экземпляра.

Адрес клиента является персональными данными.

По умолчанию этот флаг включён.

Варианты:

• false
• true

read_pool_config

dictionary

Конфигурация пула чтения.

Если тип экземпляра — READ_POOL, необходимо указать эту конфигурацию.

node_count

integer

Ёмкость чтения, то есть

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

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"

changed

boolean

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

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

createTime

string

Время создания экземпляра в формате UTC.

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

ipAddress

string

IP-адрес экземпляра.

Это конечная точка подключения для пользовательского приложения.

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

name

string

Имя ресурса экземпляра.

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

outboundPublicIpAddresses

list / elements=string

Исходящие публичные IP-адреса экземпляра.

Доступно ТОЛЬКО если для networkConfig.enableOutboundPublicIp задано значение true.

Эти IP-адреса используются для исходящих подключений.

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

publicIpAddress

string

Публичные IP-адреса экземпляра.

Доступно ТОЛЬКО если для networkConfig.enablePublicIp задано значение true.

Это конечная точка подключения для пользовательского приложения.

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

reconciling

boolean

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

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

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

state

string

Текущее состояние экземпляра AlloyDB.

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

uid

string

UID ресурса, сгенерированный системой.

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

updateTime

string

Время обновления экземпляра в формате UTC.

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