Spec-Zone.ru › Ansible 2.4

cloudformation_facts - Получение фактов о стеке AWS CloudFormation

Новая версия 2.2.

  • Обзор
  • Требования (к хосту, на котором выполняется модуль)
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус

Обзор

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

Требования (к хосту, на котором выполняется модуль)

  • boto
  • boto3 >= 1.0.0
  • python >= 2.6

Параметры

параметр обязательно по умолчанию выбор комментарии
all_facts
нет
Получить всю информацию о стеке.
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
ec2_url
нет
URL для подключения к облаку EC2 или Eucalyptus (по умолчанию используется конечная точка EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое имеется.
profile
(добавлен в 1.6)
нет
Использует профиль 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
(добавлен в 1.6)
нет
Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
псевдонимы: access_token
stack_events
нет
Получить события стека для стека.
stack_name
нет
Имя или идентификатор стека CloudFormation. По умолчанию собирает факты для всех стеков.
stack_policy
нет
Получить политику стека для стека.
stack_resources
нет
Получить ресурсы стека для стека.
stack_template
нет
Получить тело шаблона стека для стека.
validate_certs
(добавлен в 1.5)
нет да
  • да
  • нет
При значении "нет", сертификаты SSL не будут проверяться для версий boto >= 2.6.0.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Get summary information about a stack
- cloudformation_facts:
    stack_name: my-cloudformation-stack

# Facts are published in ansible_facts['cloudformation'][<stack_name>]
- debug:
    msg: "{{ ansible_facts['cloudformation']['my-cloudformation-stack'] }}"

# Get all stack information about a stack
- cloudformation_facts:
    stack_name: my-cloudformation-stack
    all_facts: true

# Get stack resource and stack policy information about a stack
- cloudformation_facts:
    stack_name: my-cloudformation-stack
    stack_resources: true
    stack_policy: true

# 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 истинно список
stack_outputs
Словарь выходов стека, ключами которого являются значения параметра 'OutputKey' каждого выхода, а соответствующие значениями — параметры 'OutputValue' каждого выхода.
всегда словарь
stack_parameters
Словарь параметров стека, ключами которого являются значения параметра 'ParameterKey' каждого параметра, а соответствующие значениями — параметры 'ParameterValue' каждого параметра.
всегда словарь
stack_policy
Описывает политику стека для стека
только если all_facts или stack_policy истинно словарь
stack_resource_list
Описывает ресурсы стека для стека
только если all_facts или stack_resourses истинно список
stack_resources
Словарь ресурсов стека, ключами которого являются значения параметра 'LogicalResourceId' каждого ресурса, а соответствующие значениями — параметры 'PhysicalResourceId' каждого ресурса.
только если all_facts или stack_resourses истинно словарь
stack_template
Описывает шаблон стека для стека
только если all_facts или stack_template истинно словарь

Примечания

Примечание

  • Если параметры не заданы в модуле, могут использоваться следующие переменные окружения в порядке убывания приоритета 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), если учетные данные не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
  • AWS_REGION или EC2_REGION могут использоваться для указания региона AWS, когда это требуется, но это также может быть настроено в файле конфигурации boto

Статус

Данный модуль помечен как предварительный, что означает, что его интерфейс не гарантируется как обратная совместимость.

Для получения помощи в разработке модулей, если у вас есть желание, пожалуйста, прочитайте Информацию о сообществе и сотрудничестве, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/cloudformation_facts_module.html

Spec-Zone.ru

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