Модуль google.cloud.gcp_sql_instance – Создаёт экземпляр GCP Instance

access_token

строка

Токен доступа OAuth2, если тип аутентификации — accesstoken.

auth_kind

строка / обязательно

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

Варианты:

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

backend_type

строка

* FIRST_GEN: экземпляр первого поколения. Только MySQL.

* SECOND_GEN: экземпляр второго поколения или экземпляр PostgreSQL.

* EXTERNAL: базовый сервер базы данных, не управляемый Google.

Некоторые допустимые варианты: «FIRST_GEN», «SECOND_GEN», «EXTERNAL»

connection_name

строка

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

database_version

строка

Тип и версия движка базы данных. Для экземпляров первого поколения — MYSQL_5_5 или MYSQL_5_6. Для экземпляров второго поколения — MYSQL_5_6 или MYSQL_5_7. По умолчанию — MYSQL_5_6.

Экземпляры PostgreSQL: POSTGRES_9_6. Свойство databaseVersion нельзя изменить после создания экземпляра.

Некоторые допустимые варианты: «MYSQL_5_5», «MYSQL_5_6», «MYSQL_5_7», «POSTGRES_9_6»

disk_encryption_configuration

словарь

Настройки шифрования диска.

kms_key_name

строка

Ключ KMS, используемый для шифрования экземпляра Cloud SQL.

disk_encryption_status

словарь

Статус шифрования диска.

kms_key_version_name

строка

Версия ключа KMS, используемая для шифрования экземпляра Cloud SQL.

env_type

строка

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

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

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

failover_replica

словарь

Имя и статус резервного реплики. Это свойство применимо только к экземплярам второго поколения.

name

строка

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

instance_type

строка

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

* CLOUD_SQL_INSTANCE: экземпляр Cloud SQL, который не дублируется с основным.

* ON_PREMISES_INSTANCE: экземпляр, работающий на оборудовании заказчика.

* READ_REPLICA_INSTANCE: экземпляр Cloud SQL, настроенный как реплика чтения.

Некоторые допустимые варианты: «CLOUD_SQL_INSTANCE», «ON_PREMISES_INSTANCE», «READ_REPLICA_INSTANCE»

ipv6_address

строка

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

master_instance_name

строка

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

max_disk_size

целое число

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

name

строка / обязательно

Имя экземпляра Cloud SQL. Идентификатор проекта не входит в него.

project

строка

Используемый проект Google Cloud Platform.

region

строка

Географический регион. По умолчанию — us-central или us-central1 в зависимости от типа экземпляра (первого поколения или второго поколения/PostgreSQL).

replica_configuration

словарь

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

failover_target

логическое значение

Указывает, является ли реплика целевой репликой для переключения. Если поле установлено в true, реплика будет обозначена как резервная реплика.

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

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

Варианты:

• false
• true

mysql_replica_configuration

словарь

Конфигурация, специфичная для MySQL, при репликации с локального MySQL-мастера. Информация о конфигурации репликации, такая как имя пользователя, пароль, сертификаты и ключи, не хранится в метаданных экземпляра. Данная информация используется только для настройки подключения репликации и хранится MySQL в файле master.info в каталоге данных.

ca_certificate

строка

Представление PEM доверенного сертификата CA x509.

client_certificate

строка

Представление PEM сертификата x509 реплики.

client_key

строка

Представление PEM закрытого ключа реплики. Соответствующий открытый ключ закодирован в сертификате реплики.

connect_retry_interval

целое число

Секунды ожидания между повторными попытками подключения. По умолчанию в MySQL — 60 секунд.

dump_file_path

строка

Путь к файлу дампов SQL в Google Cloud Storage, из которого создается реплицируемый экземпляр. URI имеет вид gs://bucketName/fileName. Также поддерживаются сжатые файлы (.gz). Дампы должны содержать координаты binlog, с которых должна начаться репликация. Это можно сделать, установив –master-data в 1 при использовании mysqldump.

master_heartbeat_period

целое число

Интервал в миллисекундах между реплицируемыми ударами сердца.

password

строка

Пароль для подключения репликации.

ssl_cipher

строка

Список допустимых шифров для шифрования SSL.

username

строка

Имя пользователя для подключения репликации.

verify_server_certificate

логическое значение

Проверка имени общего наименования (Common Name) в сертификате, отправленном мастером во время рукопожатия SSL.

Варианты:

• false
• true

replica_names

список / элементы=строка

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

service_account_email_address

строка

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

scopes

список / элементы=строка

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

service_account_contents

jsonarg

Содержимое файла JSON учетной записи сервиса, либо в виде словаря, либо как строка JSON, которая его представляет.

service_account_email

строка

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

service_account_file

путь

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

settings

словарь

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

availability_type

строка

availabilityType определяет, работает ли ваш экземпляр PostgreSQL в зональном или региональном режиме.

Некоторые допустимые значения: «ZONAL», «REGIONAL»

backup_configuration

словарь

Ежедневная конфигурация резервного копирования экземпляра.

binary_log_enabled

логическое значение

Включена ли двоичная запись. Если конфигурация резервного копирования отключена, двоичная запись также должна быть отключена. Только MySQL.

Варианты:

• false
• true

enabled

логическое значение

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

Варианты:

• false
• true

start_time

string

Определите время начала резервного копирования в UTC (ЧЧ:ММ).

database_flags

list / elements=dictionary

Флаги базы данных, передаваемые экземпляру при запуске.

name

string

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

value

string

Значение флага. Булевы значения должны быть установлены в «on» для true и «off» для false. Этот параметр должен быть опущен, если флаг не принимает значение.

ip_configuration

dictionary

Настройки управления IP-адресами. Это позволяет включить или отключить IP-адрес экземпляра и управлять внешними сетями, которые могут подключаться к экземпляру. IPv4-адрес нельзя отключить для экземпляров второго поколения.

authorized_networks

list / elements=dictionary

Список внешних сетей, которым разрешен доступ к экземпляру через IP. В формате CIDR, также известном как «с косой чертой» (например, 192.168.100.0/24).

expiration_time

string

Время истечения срока действия этого элемента управления доступом в формате RFC 3339, например 2012-11-15T16:19:00.094Z.

name

string

Необязательная метка для идентификации этого элемента.

value

string

Разрешенное значение для списка управления доступом. Например, для предоставления доступа клиенту из внешнего IP-адреса (IPv4 или IPv6) или подсети, используйте этот адрес или подсеть здесь.

ipv4_enabled

boolean

Должен ли экземпляру быть назначен IP-адрес?

Варианты:

• false
• true

private_network

string

Ссылка на ресурс сети VPC, из которой экземпляр Cloud SQL доступен по частному IP-адресу (например, /projects/myProject/global/networks/default).

require_ssl

boolean

Должен ли mysqld по умолчанию использовать «REQUIRE X509» для пользователей, подключающихся по IP?

Варианты:

• false
• true

tier

string

Уровень или тип машины для этого экземпляра, например db-n1-standard-1. Для экземпляров MySQL этот параметр определяет, является ли экземпляр второго поколения (рекомендуется) или первого поколения.

user_labels

dictionary

Метки, предоставленные пользователем, представленные как словарь, где каждая метка — это пара «ключ-значение».

state

string

Должен ли данный объект существовать в GCP?

Варианты:

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

backendType

строка

* FIRST_GEN: Экземпляр первого поколения. Только MySQL.

* SECOND_GEN: Экземпляр второго поколения или экземпляр PostgreSQL.

* EXTERNAL: Сервер базы данных, не управляемый Google.

Возвращено: успех

connectionName

строка

Имя подключения экземпляра Cloud SQL, используемое в строках подключения.

Возвращено: успех

databaseVersion

строка

Тип и версия СУБД. Для экземпляров первого поколения может быть MYSQL_5_5 или MYSQL_5_6. Для экземпляров второго поколения может быть MYSQL_5_6 или MYSQL_5_7. По умолчанию MYSQL_5_6.

Для экземпляров PostgreSQL: POSTGRES_9_6 Свойство databaseVersion изменить после создания экземпляра нельзя.

Возвращено: успех

diskEncryptionConfiguration

сложный

Настройки шифрования диска.

Возвращено: успех

kmsKeyName

строка

Ключ KMS, используемый для шифрования экземпляра Cloud SQL.

Возвращено: успех

diskEncryptionStatus

сложный

Статус шифрования диска.

Возвращено: успех

kmsKeyVersionName

строка

Версия ключа KMS, используемая для шифрования экземпляра Cloud SQL.

Возвращено: успех

failoverReplica

сложный

Имя и статус резервного реплики. Это свойство применимо только к экземплярам второго поколения.

Возвращено: успех

available

логическое

Статус доступности резервного реплики. Логическое значение false указывает, что резервный реплика не синхронизирован. Мастер может переключиться только на резервный реплика, когда статус true.

Возвращено: успех

name

строка

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

Возвращено: успех

gceZone

строка

Компьютерная зона Compute Engine, из которой в настоящее время обслуживается экземпляр. Это значение может отличаться от зоны, указанной при создании экземпляра, если экземпляр переключился на вторичную зону.

Возвращено: успех

instanceType

строка

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

* CLOUD_SQL_INSTANCE: Экземпляр Cloud SQL, который не дублируется с мастера.

* ON_PREMISES_INSTANCE: Экземпляр, работающий на предприятии клиента.

* READ_REPLICA_INSTANCE: Экземпляр Cloud SQL, настроенный как реплика для чтения.

Возвращено: успех

ipAddresses

сложный

Назначенные IP-адреса для экземпляра.

Возвращено: успех

ipAddress

строка

Назначенный IP-адрес.

Возвращено: успех

timeToRetire

строка

Время, к которому следует удалить этот IP-адрес в формате RFC 3339, например 2012-11-15T16:19:00.094Z. Это поле доступно только при планируемом удалении IP-адреса.

Возвращено: успех

type

строка

Тип этого IP-адреса. IP-адрес PRIMARY может принимать входящие подключения. IP-адрес OUTGOING — это исходный адрес подключений, исходящих из экземпляра, если поддерживается.

Возвращено: успех

ipv6Address

строка

Назначенный IPv6-адрес экземпляра. Это свойство применимо только к экземплярам первого поколения.

Возвращено: успех

masterInstanceName

строка

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

Возвращено: успех

maxDiskSize

целое число

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

Возвращено: успех

name

string

Имя экземпляра Cloud SQL. Это не включает идентификатор проекта.

Возвращено: success

region

string

Географический регион. По умолчанию us-central или us-central1 в зависимости от типа экземпляра (первое поколение или второе поколение/PostgreSQL).

Возвращено: success

replicaConfiguration

complex

Конфигурация, специфичная для реплик отработки отказа и реплик чтения.

Возвращено: success

failoverTarget

boolean

Указывает, является ли реплика целевым объектом отработки отказа. Если поле установлено в true, реплика будет обозначена как реплика отработки отказа.

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

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

Возвращено: success

mysqlReplicaConfiguration

complex

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

Возвращено: success

caCertificate

string

PEM-представление доверенного сертификата X.509 ЦС.

Возвращено: success

clientCertificate

string

PEM-представление сертификата X.509 реплики.

Возвращено: success

clientKey

string

PEM-представление закрытого ключа реплики. Соответствующий открытый ключ закодирован в сертификате клиента.

Возвращено: success

connectRetryInterval

integer

Время ожидания в секундах между попытками повторного подключения. Значение по умолчанию для MySQL — 60 секунд.

Возвращено: success

dumpFilePath

string

Путь к файлу SQL-дампа в Google Cloud Storage, из которого должен быть создан экземпляр реплики. URI имеет вид gs://bucketName/fileName. Также поддерживаются сжатые gzip-файлы (.gz). Дампы должны содержать координаты binlog, с которых должна начинаться репликация. Этого можно добиться, установив –master-data в 1 при использовании mysqldump.

Возвращено: success

masterHeartbeatPeriod

integer

Интервал в миллисекундах между сигналами «сердцебиение» репликации.

Возвращено: success

password

string

Пароль для подключения репликации.

Возвращено: success

sslCipher

string

Список допустимых шифров для использования при шифровании SSL.

Возвращено: success

username

string

Имя пользователя для подключения репликации.

Возвращено: success

verifyServerCertificate

boolean

Проверять ли значение общего имени основного сервера в сертификате, который он отправляет во время SSL-handshake.

Возвращено: success

replicaNames

list / elements=string

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

Возвращено: success

serviceAccountEmailAddress

string

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

Возвращено: success

serverCaCert

complex

Конфигурация SSL.

Возвращено: success

cert

string

PEM-представление сертификата X.509.

Возвращено: success

certSerialNumber

string

Серийный номер, извлечённый из сертификата.

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

commonName

string

Имя, заданное пользователем. Ограничено значением [a-zA-Z.-_ ]+.

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

createTime

string

Время создания сертификата в формате RFC 3339, например 2012-11-15T16:19:00.094Z.

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

expirationTime

string

Время истечения срока действия сертификата в формате RFC 3339, например 2012-11-15T16:19:00.094Z.

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

sha1Fingerprint

string

SHA-1 отпечаток сертификата.

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

settings

complex

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

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

availabilityType

string

Тип доступности определяет, работает ли ваш экземпляр PostgreSQL в зоновой или региональной конфигурации.

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

backupConfiguration

complex

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

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

binaryLogEnabled

boolean

Включено ли двоичное протоколирование. Если резервное копирование отключено, двоичное протоколирование должно быть также отключено. Только MySQL.

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

enabled

boolean

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

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

startTime

string

Укажите время начала резервного копирования в UTC (ЧЧ:ММ).

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

databaseFlags

complex

Флаги базы данных, переданные экземпляру при запуске.

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

name

string

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

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

value

string

Значение флага. Логические значения должны быть установлены в «включено» для true и «выключено» для false. Это поле должно быть опущено, если флаг не принимает значение.

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

ipConfiguration

complex

Настройки IP-адресации. Это позволяет включить или выключить IP-адрес экземпляра и управлять внешними сетями, которые могут подключаться к экземпляру. IPv4-адрес нельзя отключить для экземпляров второго поколения.

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

authorizedNetworks

complex

Список внешних сетей, которым разрешено подключение к экземпляру через IP. В формате CIDR, также известном как «формат с косой чертой» (например, 192.168.100.0/24).

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

expirationTime

string

Время истечения срока действия записи управления доступом в формате RFC 3339, например 2012-11-15T16:19:00.094Z.

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

name

string

Необязательная метка для идентификации этой записи.

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

value

string

Указанное значение для списка управления доступом. Например, для предоставления доступа к клиенту с внешнего IP-адреса (IPv4 или IPv6) или подсети укажите этот адрес или подсеть здесь.

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

ipv4Enabled

boolean

Должен ли экземпляру быть назначен IP-адрес.

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

requireSsl

boolean

Требуется ли по умолчанию ‘REQUIRE X509’ для пользователей, подключающихся по IP.

Возвращаемое значение: success

settingsVersion

integer

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

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

Возвращаемое значение: success

tier

string

Уровень или тип машины для этого экземпляра, например db-n1-standard-1. Для экземпляров MySQL это поле определяет, является ли экземпляр второго поколения (рекомендуется) или первого поколения.

Возвращаемое значение: success

userLabels

dictionary

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

Возвращаемое значение: success

state

string

Текущее состояние работы экземпляра базы данных.

Возвращаемое значение: success