amazon.aws.cloudformation_info – Получение информации о стеке AWS CloudFormation
Примечание
Этот плагин входит в состав коллекции amazon.aws (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install amazon.aws
Для использования в плейбуке укажите: amazon.aws.cloudformation_info
Добавлено в версии 1.0.0: из amazon.aws
Обзор
- Получает информацию о стеке AWS CloudFormation.
- Этот модуль назывался
amazon.aws.cloudformation_factsдо Ansible 2.9, возвращаяansible_facts. Обратите внимание, что модуль amazon.aws.cloudformation_info больше не возвращаетansible_facts!
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- boto
- boto3 >= 1.0.0
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| all_facts boolean |
| Получить всю информацию о стеке для данного стека. |
| aws_access_key строка | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное указание параметров aws_access_key и profile устарело и станет взаимно исключающим после 2022-06-01. псевдонимы: ec2_access_key, access_key | |
| aws_ca_bundle путь | Расположение файла сертификатов CA для проверки SSL-сертификатов. Используется только для модулей на основе boto3. Примечание: Файл сертификатов CA читается со стороны модуля и может потребоваться явное копирование его с контроллера, если выполнение не происходит локально. | |
| aws_config словарь | Словарь для изменения настроек botocore. Параметры можно найти на https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Только ключ 'user_agent' используется для модулей boto. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для более подробной информации о настройках boto. | |
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное указание параметров aws_secret_key и profile устарело и станет взаимно исключающим после 2022-06-01. псевдонимы: ec2_secret_key, secret_key | |
| debug_botocore_endpoint_logs boolean |
| Используйте регистратор botocore.endpoint для анализа уникальных (а не суммарных) API-вызовов «ресурс:действие», произведённых во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода общего списка, созданного во время плейбука. Переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована. |
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где регион обязателен. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое имеется. псевдонимы: aws_endpoint_url, endpoint_url | |
| profile строка | Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token, а поддержка одновременного указания их с profile устарела. aws_access_key, aws_secret_key и security_token станут взаимно исключающими с profile после 2022-06-01. псевдонимы: aws_profile | |
| region строка | Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковое имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | |
| security_token строка | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Одновременное указание параметров security_token и profile устарело и станет взаимно исключающим после 2022-06-01. псевдонимы: aws_security_token, access_token | |
| stack_change_sets boolean |
| Получить наборы изменений стека для стека |
| stack_events boolean |
| Получить события стека для стека. |
| stack_name строка | Имя или идентификатор стека CloudFormation. По умолчанию собирает информацию обо всех стеках. | |
| stack_policy boolean |
| Получить политику стека для стека. |
| stack_resources boolean |
| Получить ресурсы стека для стека. |
| stack_template boolean |
| Получить шаблон тела стека для стека. |
| validate_certs boolean |
| При значении "нет", SSL-сертификаты не будут проверены для версий boto >= 2.6.0. |
Примечания
Примечание
- Если параметры не заданы внутри модуля, можно использовать следующие переменные окружения в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_PROFILEилиAWS_DEFAULT_PROFILE,AWS_ACCESS_KEY_IDилиAWS_ACCESS_KEYилиEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYилиAWS_SECRET_KEYилиEC2_SECRET_KEY,AWS_SECURITY_TOKENилиEC2_SECURITY_TOKEN,AWS_REGIONилиEC2_REGION,AWS_CA_BUNDLE - Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в файле конфигурации boto
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Get summary information about a stack
amazon.aws.cloudformation_info:
stack_name: my-cloudformation-stack
register: output
- debug:
msg: "{{ output['cloudformation']['my-cloudformation-stack'] }}"
# When the module is called as cloudformation_facts, return values are published
# in ansible_facts['cloudformation'][<stack_name>] and can be used as follows.
# Note that this is deprecated and will stop working in Ansible after 2021-12-01.
- amazon.aws.cloudformation_facts:
stack_name: my-cloudformation-stack
- debug:
msg: "{{ ansible_facts['cloudformation']['my-cloudformation-stack'] }}"
# Get stack outputs, when you have the stack name available as a fact
- set_fact:
stack_name: my-awesome-stack
- amazon.aws.cloudformation_info:
stack_name: "{{ stack_name }}"
register: my_stack
- debug:
msg: "{{ my_stack.cloudformation[stack_name].stack_outputs }}"
# Get all stack information about a stack
- amazon.aws.cloudformation_info:
stack_name: my-cloudformation-stack
all_facts: true
# Get stack resource and stack policy information about a stack
- amazon.aws.cloudformation_info:
stack_name: my-cloudformation-stack
stack_resources: true
stack_policy: true
# Fail if the stack doesn't exist
- name: try to get facts about a stack but fail if it doesn't exist
amazon.aws.cloudformation_info:
stack_name: nonexistent-stack
all_facts: yes
failed_when: cloudformation['nonexistent-stack'] is undefined
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| stack_change_sets список / элементы=строка | только если все_факты или stack_change_sets истинно и стек существует | Список наборов изменений стека. Каждый элемент в списке представляет детали конкретного набора изменений |
| stack_description словарь | если стек существует | Сводные факты о стеке |
| stack_events список / элементы=строка | только если все_факты или stack_events истинно и стек существует | Все события стека для стека |
| stack_outputs словарь | если стек существует | Словарь выходов стека, ключами которого являются значения параметра 'OutputKey' каждого выхода, а соответствующие значения - параметром 'OutputValue' каждого выхода Пример: {'ApplicationDatabaseName': 'dazvlpr01xj55a.ap-southeast-2.rds.amazonaws.com'} |
| stack_parameters словарь | если стек существует | Словарь параметров стека, ключами которого являются значения параметра 'ParameterKey' каждого параметра, а соответствующие значения - параметром 'ParameterValue' каждого параметра Пример: {'DatabaseEngine': 'mysql', 'DatabasePassword': '***'} |
| stack_policy словарь | только если все_факты или stack_policy истинно и стек существует | Описание политики стека для стека |
| stack_resource_list список / элементы=строка | только если все_факты или stack_resourses истинно и стек существует | Описание ресурсов стека для стека |
| stack_resources словарь | только если все_факты или stack_resourses истинно и стек существует | Словарь ресурсов стека, ключами которого являются значения параметра 'LogicalResourceId' каждого ресурса, а соответствующие значения - параметром 'PhysicalResourceId' каждого ресурса Пример: {'ApplicationDatabase': 'dazvlpr01xj55a', 'AutoScalingGroup': 'dev-someapp-AutoscalingGroup-1SKEXXBCAN0S7', 'AutoScalingSecurityGroup': 'sg-abcd1234'} |
| stack_template словарь | только если все_факты или stack_template истинно и стек существует | Описание шаблона стека для стека |
Авторы
- Justin Menga (@jmenga)
- Kevin Coming (@waffie1)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/amazon/aws/cloudformation_info_module.html