Spec-Zone.ru › Ansible 2.9

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

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

Краткое описание

  • Получает информацию о стеке AWS CloudFormation
  • Этот модуль назывался cloudformation_facts до Ansible 2.9, возвращая ansible_facts. Обратите внимание, что модуль cloudformation_info больше не возвращает ansible_facts!

Псевдонимы: cloudformation_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.

Псевдонимы: ec2_access_key, access_key
aws_secret_key
строка
Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.

Псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
boolean
добавлено в 2.8
    Варианты:
  • нет ←
  • да
Использовать логирователь botocore.endpoint для разбора уникальных (а не общих) API-вызовов «resource:action», сделанных во время задачи, выводящих набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода общего списка, сделанного во время выполнения книги команд.
Переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
ec2_url
строка
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не указан, используется значение переменной окружения EC2_URL, если она есть.
profile
строка
Использует профиль boto. Работает только с boto >= 2.24.0.
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.

Псевдонимы: access_token
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_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
  • 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.

# Get summary information about a stack
- 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 2.13.

- 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

- 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
- cloudformation_info:
    stack_name: my-cloudformation-stack
    all_facts: true

# Get stack resource and stack policy information about a stack
- 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
  cloudformation_info:
    stack_name: nonexistent-stack
    all_facts: yes
  failed_when: cloudformation['nonexistent-stack'] is undefined

# Example dictionary outputs for stack_outputs, stack_parameters and stack_resources:
# "stack_outputs": {
#     "ApplicationDatabaseName": "dazvlpr01xj55a.ap-southeast-2.rds.amazonaws.com",
#     ...
# },
# "stack_parameters": {
#     "DatabaseEngine": "mysql",
#     "DatabasePassword": "****",
#     ...
# },
# "stack_resources": {
#     "AutoscalingGroup": "dev-someapp-AutoscalingGroup-1SKEXXBCAN0S7",
#     "AutoscalingSecurityGroup": "sg-abcd1234",
#     "ApplicationDatabase": "dazvlpr01xj55a",
#     "EcsTaskDefinition": "arn:aws:ecs:ap-southeast-2:123456789:task-definition/dev-someapp-EcsTaskDefinition-1F2VM9QB0I7K9:1"
#     ...
# }

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

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

Ключ Возвращённое значение Описание
stack_description
словарь
если стек существует
Сводная информация о стеке

stack_events
список
только если all_facts или stack_events равно true и стек существует
Все события стека для стека

stack_outputs
словарь
если стек существует
Словарь выходных данных стека, ключи которого соответствуют значению параметра каждого выходного «OutputKey», а соответствующие значения — параметру каждого выходного «OutputValue»

stack_parameters
словарь
если стек существует
Словарь параметров стека, ключи которого соответствуют значению параметра каждого параметра «ParameterKey», а соответствующие значения — параметру каждого параметра «ParameterValue»

stack_policy
словарь
только если all_facts или stack_policy равно true и стек существует
Описание политики стека для стека

stack_resource_list
список
только если all_facts или stack_resourses равно true и стек существует
Описание ресурсов стека для стека

stack_resources
словарь
только если all_facts или stack_resourses равно true и стек существует
Словарь ресурсов стека, ключи которого соответствуют значению параметра каждого ресурса «LogicalResourceId», а соответствующие значения — параметру каждого ресурса «PhysicalResourceId»

stack_template
словарь
только если all_facts или stack_template равно true и стек существует
Описание шаблона стека для стека



Статус

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

Авторы

  • Justin Menga (@jmenga)

Подсказка

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

© 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/cloudformation_info_module.html

Spec-Zone.ru

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