модуль google.cloud.gcp_sql_instance – Создание экземпляра GCP

access_token

string

Токен доступа OAuth2, если тип учетных данных — accesstoken.

auth_kind

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

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

Варианты:

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

backend_type

string

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

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

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

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

connection_name

string

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

database_version

string

Тип и версия ядра базы данных. Для экземпляров первого поколения допустимы 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

dictionary

Параметры шифрования диска.

kms_key_name

string

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

disk_encryption_status

dictionary

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

kms_key_version_name

string

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

env_type

string

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

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

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

failover_replica

dictionary

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

name

string

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

instance_type

string

Тип экземпляра. Возможны следующие значения.

* CLOUD_SQL_INSTANCE: экземпляр Cloud SQL, не реплицирующий данные с главного экземпляра.

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

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

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

ipv6_address

string

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

master_instance_name

string

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

max_disk_size

integer

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

name

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

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

project

string

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

region

string

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

replica_configuration

dictionary

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

failover_target

boolean

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

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

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

Варианты:

• false
• true

mysql_replica_configuration

dictionary

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

ca_certificate

string

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

client_certificate

string

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

client_key

string

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

connect_retry_interval

integer

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

dump_file_path

string

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

master_heartbeat_period

integer

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

password

string

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

ssl_cipher

string

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

username

string

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

verify_server_certificate

boolean

Следует ли проверять значение Common Name главного сервера в сертификате, который он отправляет во время SSL-рукопожатия.

Варианты:

• false
• true

replica_names

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

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

service_account_email_address

string

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

scopes

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

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

service_account_contents

jsonarg

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

service_account_email

string

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

service_account_file

path

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

settings

dictionary

Пользовательские настройки.

availability_type

string

Параметр availabilityType определяет, будет ли экземпляр PostgreSQL работать в одной зоне или в нескольких регионах.

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

backup_configuration

dictionary

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

binary_log_enabled

boolean

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

Варианты:

• false
• true

enabled

boolean

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

Варианты:

• false
• true

start_time

string

Задать время начала резервного копирования в формате UTC (HH:MM).

database_flags

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

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

name

string

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

value

string

Значение флага. Для логических значений следует указывать on для true и off для false. Это поле необходимо опустить, если флаг не принимает значение.

ip_configuration

dictionary

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

allocated_ip_range

string

Имя выделенного диапазона IP-адресов для экземпляра Cloud SQL с частным IP-адресом. Должно совпадать с именем существующего выделенного диапазона IP-адресов в VPC.

authorized_networks

list / элементы=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

string

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

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

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

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

connectionName

string

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

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

databaseVersion

string

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

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

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

diskEncryptionConfiguration

complex

Параметры шифрования диска.

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

kmsKeyName

string

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

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

diskEncryptionStatus

complex

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

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

kmsKeyVersionName

string

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

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

failoverReplica

complex

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

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

available

boolean

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

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

name

string

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

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

gceZone

string

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

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

instanceType

string

Тип экземпляра. Возможны следующие значения.

* CLOUD_SQL_INSTANCE: экземпляр Cloud SQL, не реплицирующий данные с главного экземпляра.

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

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

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

ipAddresses

complex

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

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

ipAddress

string

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

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

timeToRetire

string

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

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

type

string

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

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

ipv6Address

string

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

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

masterInstanceName

string

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

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

maxDiskSize

integer

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

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

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

Сертификат x509 доверенного центра сертификации в формате PEM.

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

clientCertificate

string

Сертификат x509 реплики в формате PEM.

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

clientKey

string

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

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

connectRetryInterval

integer

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

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

dumpFilePath

string

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

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

masterHeartbeatPeriod

integer

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

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

password

string

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

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

sslCipher

string

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

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

username

string

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

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

verifyServerCertificate

boolean

Проверять ли значение Common Name главного сервера в сертификате, который он отправляет во время SSL-рукопожатия.

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

replicaNames

list / elements=string

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

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

serviceAccountEmailAddress

string

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

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

serverCaCert

complex

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

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

cert

string

Сертификат X.509 в формате PEM.

Возвращается: 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

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

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

backupConfiguration

complex

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

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

binaryLogEnabled

boolean

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

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

enabled

boolean

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

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

startTime

string

Задать время начала резервного копирования в формате UTC (HH:MM).

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

databaseFlags

complex

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

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

name

string

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

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

value

string

Значение флага. Для логических значений укажите on для true и off для false. Это поле следует опустить, если флаг не принимает значение.

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

ipConfiguration

complex

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

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

allocatedIpRange

string

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

Возвращается: при успехе

authorizedNetworks

complex

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

Возвращается: при успехе

expirationTime

string

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

Возвращается: при успехе

name

string

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

Возвращается: при успехе

value

string

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

Возвращается: при успехе

ipv4Enabled

boolean

Следует ли назначить экземпляру IP-адрес.

Возвращается: при успехе

requireSsl

boolean

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

Возвращается: при успехе

settingsVersion

integer

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

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

Возвращается: при успехе

tier

string

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

Возвращается: при успехе

userLabels

dictionary

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

Возвращается: при успехе

state

string

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

Возвращается: при успехе