модуль google.cloud.gcp_pubsub_topic — создание темы GCP

Примечание

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

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

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

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

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

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

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

Требования

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

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Комментарии
access_token string	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind string / обязательный	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
env_type string	Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Он изменяет только строку User Agent для всех запросов API.
kms_key_name string	Имя ресурса Cloud KMS CryptoKey, который будет использоваться для защиты доступа к сообщениям, опубликованным в этой теме. Чтобы использовать эту функцию, учетная запись службы PubSub проекта (`service-{{PROJECT_NUMBER}}@gcp-sa-pubsub.iam.gserviceaccount.com`) должна иметь роль `roles/cloudkms.cryptoKeyEncrypterDecrypter`. Ожидаемый формат: `projects//locations//keyRings//cryptoKeys/` .
labels dictionary	Набор пар «ключ/значение» для присвоения этой теме.
message_storage_policy dictionary	Политика, ограничивающая набор регионов Google Cloud Platform, в которых могут храниться сообщения, опубликованные в теме. Если политика не задана, ограничения не применяются.
allowed_persistence_regions list / элементы=string / обязательный	Список идентификаторов регионов GCP, в которых сообщения, опубликованные в теме, могут сохраняться в хранилище. Сообщения, опубликованные издателями, работающими в регионах GCP, не входящих в список разрешенных (или вообще за пределами GCP), будут направлены на хранение в один из разрешенных регионов. Пустой список означает, что ни один регион не разрешен, и не является допустимой конфигурацией.
name string / обязательный	Название темы.
project string	Проект Google Cloud Platform, который следует использовать.
schema_settings dictionary	Настройки проверки опубликованных сообщений на соответствие схеме.
encoding string	Кодировка сообщений, проверяемых на соответствие схеме. Допустимые варианты: “ENCODING_UNSPECIFIED”, “JSON”, “BINARY” По умолчанию: `"ENCODING_UNSPECIFIED"`
schema string / обязательный	Название схемы, на соответствие которой должны проверяться публикуемые сообщения. Формат: projects/{project}/schemas/{schema}. Если схема удалена, значением этого поля будет _deleted-schema_.
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"`

Примечания

Примечание

Справочник API: https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics
Управление темами: https://cloud.google.com/pubsub/docs/admin#managing_topics
Для аутентификации можно задать 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.
Для аутентификации можно задать auth_kind с помощью переменной окружения GCP_AUTH_KIND.
Для аутентификации можно задать scopes с помощью переменной окружения GCP_SCOPES.
Значения переменных окружения используются только в том случае, если значения не заданы в плейбуке.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: create a topic
  google.cloud.gcp_pubsub_topic:
    name: test-topic1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ	Описание
kmsKeyName string	Имя ресурса Cloud KMS CryptoKey, который будет использоваться для защиты доступа к сообщениям, опубликованным в этой теме. Чтобы использовать эту функцию, учетная запись службы PubSub проекта (`service-{{PROJECT_NUMBER}}@gcp-sa-pubsub.iam.gserviceaccount.com`) должна иметь роль `roles/cloudkms.cryptoKeyEncrypterDecrypter`. Ожидаемый формат: `projects//locations//keyRings//cryptoKeys/` . Возвращается: success
labels dictionary	Набор пар «ключ/значение» для присвоения этой теме. Возвращается: success
messageStoragePolicy complex	Политика, ограничивающая набор регионов Google Cloud Platform, в которых могут храниться сообщения, опубликованные в теме. Если политика не задана, ограничения не применяются. Возвращается: success
allowedPersistenceRegions list / элементы=string	Список идентификаторов регионов GCP, в которых сообщения, опубликованные в теме, могут сохраняться в хранилище. Сообщения, опубликованные издателями, работающими в регионах GCP, не входящих в список разрешенных (или вообще за пределами GCP), будут направлены на хранение в один из разрешенных регионов. Пустой список означает, что ни один регион не разрешен, и не является допустимой конфигурацией. Возвращается: success
name string	Название темы. Возвращается: success
schemaSettings complex	Настройки проверки опубликованных сообщений на соответствие схеме. Возвращается: success
encoding string	Кодировка сообщений, проверяемых на соответствие схеме. Возвращается: success
schema string	Название схемы, на соответствие которой должны проверяться публикуемые сообщения. Формат: projects/{project}/schemas/{schema}. Если схема удалена, значением этого поля будет _deleted-schema_. Возвращается: success

Авторы

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_pubsub_topic_module.html