gcp_pubsub_topic – Создание темы GCP

Новая в версии 2.6.

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

Описание

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

Требования

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

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно		Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
env_type строка			Указывает, в какой среде Ansible выполняется данный модуль. Это поле не следует заполнять, если вы не уверены в том, что делаете. Это влияет только на строку User Agent для запросов API.
kms_key_name строка добавлено в 2.9			Имя ресурса шифрования Cloud KMS CryptoKey, используемого для защиты доступа к сообщениям, опубликованным в этой теме. Учетная запись службы PubSub вашего проекта (`service-{{PROJECT_NUMBER}}@gcp-sa-pubsub.iam.gserviceaccount.com`) должна иметь роль `roles/cloudkms.cryptoKeyEncrypterDecrypter`, чтобы использовать эту функцию. Ожидаемый формат: `projects//locations//keyRings//cryptoKeys/` .
labels словарь добавлено в 2.8			Набор пар «ключ-значение» меток, назначаемых этой теме.
message_storage_policy словарь добавлено в 2.9			Политика, ограничивающая набор регионов Google Cloud Platform, в которых могут храниться сообщения, опубликованные в теме. Если не указано, ограничения не действуют.
	allowed_persistence_regions список / обязательно		Список идентификаторов регионов GCP, в которых сообщения, опубликованные в теме, могут храниться в памяти. Сообщения, опубликованные издателями, работающими в недопустимых регионах GCP (или работающими вне GCP), будут направляться на хранение в один из разрешенных регионов. Пустой список означает, что разрешены не все регионы, и это недействительная конфигурация.
name строка / обязательно			Имя темы.
project строка			Проект Google Cloud Platform, который использовать.
scopes список			Массив используемых областей.
service_account_contents jsonarg			Содержание файла JSON учетной записи службы, представленное в виде словаря или JSON-строки.
service_account_email строка			Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь			Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.
state строка		Варианты: present ← absent	Требуется ли существование данного объекта в GCP

Примечания

Примечание

Ссылка на API: https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics
Управление темами: https://cloud.google.com/pubsub/docs/admin#managing_topics
для аутентификации можно установить service_account_file с помощью переменной среды c(gcp_service_account_file).
для аутентификации можно установить service_account_contents с помощью переменной среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
для аутентификации можно установить service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
для аутентификации можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
для аутентификации можно установить scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

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

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

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

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

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Google Inc. (@googlecloudplatform)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/gcp_pubsub_topic_module.html