Spec-Zone.ru › Ansible 2.10

amazon.aws.cloudformation_info – Получение информации об AWS CloudFormation стеке

Примечание

Этот плагин входит в коллекцию amazon.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install amazon.aws.

Для использования в playbook, укажите: 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 Bundle читается со стороны модуля и, возможно, потребуется явно скопировать его с контроллера, если он не выполняется локально.
aws_config
словарь
Словарь для изменения конфигурации botocore.
Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Только ключ 'user_agent' используется для boto-модулей. Более подробную информацию о конфигурации boto можно найти по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#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 для вывода полного списка, созданного во время выполнения playbook. Переменная среды 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 security token. Если не задан, используется значение переменной среды 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/amazon/aws/cloudformation_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API