Модуль community.aws.sns_topic_info — модуль sns_topic_info
Примечание
Этот модуль входит в коллекцию community.aws (версия 10.1.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.aws. Для работы с этим модулем требуются дополнительные зависимости; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: community.aws.sns_topic_info.
Добавлено в community.aws 3.2.0
Краткое описание
- Модуль community.aws.sns_topic_info позволяет получить сведения обо всех темах AWS SNS или свойствах определённой темы AWS SNS.
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- python >= 3.6
- boto3 >= 1.34.0
- botocore >= 1.34.0
Параметры
Параметр | Комментарии |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_access_key string | Идентификатор ключа доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK. |
aws_ca_bundle path | Путь к пакету центров сертификации, который используется для проверки SSL-сертификатов. Также можно использовать переменную среды |
aws_config dictionary | Словарь для изменения конфигурации botocore. Описание параметров см. в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs boolean | Использовать регистратор Также можно использовать переменную среды Варианты:
|
endpoint_url псевдонимы: aws_endpoint_url string | URL для подключения вместо используемых по умолчанию конечных точек AWS. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды |
profile псевдонимы: aws_profile string | Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token. |
region псевдонимы: aws_region string | Регион AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. |
secret_key псевдонимы: aws_secret_access_key, aws_secret_key string | Секретный ключ доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK. |
session_token псевдонимы: aws_session_token string | Токен сеанса AWS STS для использования с временными учетными данными. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную среды Параметры session_token и profile взаимоисключающие. |
topic_arn string | ARN темы AWS SNS, для которой требуется найти подписки или получить список атрибутов. |
validate_certs boolean | Если задано значение Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «хоста» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «хоста».
- Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте «хоста» Ansible (обычно
~/.aws/credentials). Дополнительные сведения см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.
Примеры
- name: list all the topics
community.aws.sns_topic_info:
register: sns_topic_list
- name: get info on specific topic
community.aws.sns_topic_info:
topic_arn: "{{ sns_arn }}"
register: sns_topic_info
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
result list / elements=string | Результат, содержащий сведения об одной или всех темах AWS SNS. Возвращается: при успешном выполнении |
|
sns_arn string |
ARN темы. Возвращается: всегда Пример: |
|
sns_topic complex |
Словарь со сведениями о теме SNS. Возвращается: всегда |
|
content_based_deduplication string |
Указывает, задан ли параметр content_based_deduplication. Возвращается: всегда Пример: |
|
delivery_policy string |
Политика доставки для темы SNS. Возвращается: если тема принадлежит этой учетной записи AWS Пример: |
|
display_name string |
Отображаемое имя темы SNS. Возвращается: если тема принадлежит этой учетной записи AWS Пример: |
|
owner string |
Учетная запись AWS, которой принадлежит тема. Возвращается: если тема принадлежит этой учетной записи AWS Пример: |
|
policy string |
Политика для темы SNS. Возвращается: если тема принадлежит этой учетной записи AWS Пример: |
|
subscriptions list / elements=string |
Список подписчиков темы в этой учетной записи AWS. Возвращается: всегда Пример: |
|
subscriptions_added list / elements=string |
Список подписчиков, добавленных при этом запуске. Возвращается: всегда Пример: |
|
subscriptions_confirmed string |
Количество подтвержденных подписок. Возвращается: если тема принадлежит этой учетной записи AWS Пример: |
|
subscriptions_deleted string |
Количество удаленных подписок. Возвращается: если тема принадлежит этой учетной записи AWS Пример: |
|
subscriptions_existing list / elements=string |
Список существующих подписок. Возвращается: всегда Пример: |
|
subscriptions_new list / elements=string |
Список новых подписок. Возвращается: всегда Пример: |
|
subscriptions_pending string |
Количество ожидающих подтверждения подписок. Возвращается: если тема принадлежит этой учетной записи AWS Пример: |
|
subscriptions_purge boolean |
Указывает, задан ли параметр purge_subscriptions. Возвращается: всегда Пример: |
|
topic_arn string |
ARN темы SNS (эквивалент sns_arn). Возвращается: если тема принадлежит этой учетной записи AWS Пример: |
|
topic_type string |
Тип темы. Возвращается: при успешном выполнении Пример: |
Ссылки на коллекцию
© 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/community/aws/sns_topic_info_module.html