Модуль community.aws.sns_topic_info — Модуль sns_topic_info
Примечание
Этот модуль является частью коллекции community.aws (версия 8.0.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.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка | Идентификатор ключа доступа 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 для согласованности с SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
aws_ca_bundle путь | Расположение файла сертификата CA для проверки SSL-сертификатов. Также может использоваться переменная среды |
aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs логический тип | Использование Также может использоваться переменная среды Варианты:
|
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка | URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws протестированы только для AWS. Также могут использоваться переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
profile псевдонимы: aws_profile строка | Используемый профиль AWS для аутентификации. Дополнительную информацию о профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также может использоваться переменная среды Опция profile взаимоисключающая с опциями aws_access_key, aws_secret_key и security_token. |
region псевдонимы: aws_region, ec2_region строка | Используемый регион 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, ec2_secret_key строка | Секретный ключ доступа 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 для согласованности с SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
session_token псевдонимы: aws_session_token, security_token, aws_security_token, access_token строка | Токен сессии AWS STS для использования с временными учетными данными. Дополнительную информацию об маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут использоваться переменные среды Опции security_token и profile взаимоисключающие. Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды |
topic_arn строка | ARN темы AWS SNS, для которой необходимо найти подписки или список атрибутов. |
validate_certs boolean | При установке в Установка validate_certs=false категорически не рекомендуется, в качестве альтернативы, рассмотрите настройку aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не «контроллер». Поэтому файлы могут потребоваться скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не «хост».
- AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте 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. Возвращается: success |
|
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 |
Тип темы. Возвращаемое значение: success Пример: |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/sns_topic_info_module.html