Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции amazon.aws (версия 8.2.1).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Чтобы использовать его в книге задач, укажите: amazon.aws.cloudformation_info.

Новое в amazon.aws 1.0.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата

Обзор

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

Требования

Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.

  • 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_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY в порядке убывания приоритета.

Параметры aws_access_key и profile взаимоисключающие.

Псевдоним aws_access_key_id добавлен в релизе 5.1.0 для соответствия SDK AWS botocore.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

all_facts

булево

Получить всю информацию о стеке для стека.

Варианты:

  • false ← (по умолчанию)
  • true

aws_ca_bundle

путь

Расположение пакета CA для проверки сертификатов SSL.

Также можно использовать переменную среды AWS_CA_BUNDLE.

aws_config

словарь

Словарь для изменения конфигурации botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

булево

Использовать botocore.endpoint логгер для анализа уникальных (а не общих) "resource:action" API-вызовов, выполненных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте aws_resource_action обратный вызов для вывода в общий список, сделанный во время выполнения книги сценариев.

Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

  • false ← (по умолчанию)
  • true

endpoint_url

псевдонимы: ec2_url, aws_endpoint_url, s3_url

строка

URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим службам, совместимым с AWS, коллекции amazon.aws и community.aws протестированы только с AWS.

Также можно использовать переменные среды AWS_URL или EC2_URL в порядке убывания приоритета.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

profile

псевдонимы: aws_profile

строка

Используемый профиль AWS с именем для аутентификации.

Дополнительную информацию об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также можно использовать переменную среды AWS_PROFILE.

Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token.

region

псевдонимы: aws_region, ec2_region

строка

Используемый регион AWS.

Для глобальных служб, таких как IAM, Route53 и CloudFront, параметр region игнорируется.

Также можно использовать переменные среды AWS_REGION или EC2_REGION.

Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

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.

Также можно использовать переменные среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, или EC2_SECRET_KEY в порядке убывания приоритета.

Параметры secret_key и profile взаимоисключающие.

Псевдоним aws_secret_access_key добавлен в релизе 5.1.0 для соответствия SDK AWS botocore.

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды 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.

Также можно использовать переменные среды AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

Параметры 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.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.
END_OF_DOCUMENT_MARKER

stack_change_sets

boolean

Получить наборы изменений стека для стека

Варианты:

  • false ← (по умолчанию)
  • true

stack_events

boolean

Получить события стека для стека.

Варианты:

  • false ← (по умолчанию)
  • true

stack_name

string

Имя или идентификатор стека CloudFormation. По умолчанию собирает информацию обо всех стеках.

stack_policy

boolean

Получить политику стека для стека.

Варианты:

  • false ← (по умолчанию)
  • true

stack_resources

boolean

Получить ресурсы стека для стека.

Варианты:

  • false ← (по умолчанию)
  • true

stack_template

boolean

Получить тело шаблона стека для стека.

Варианты:

  • false ← (по умолчанию)
  • true

validate_certs

boolean

Если установлено значение false, сертификаты SSL для связи с AWS API не будут проверены.

Настройка validate_certs=false крайне не рекомендуется. В качестве альтернативы, рассмотрите настройку aws_ca_bundle вместо этого.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Предупреждение: Для модулей переменные окружения и конфигурационные файлы считываются из контекста Ansible «хоста», а не «контроллера». Поэтому файлы могут потребоваться скопировать на «хост». Для плагинов поиска и подключения переменные окружения и конфигурационные файлы считываются из контекста Ansible «контроллера», а не «хоста».
  • AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте Ansible «хоста» (обычно ~/.aws/credentials). Дополнительную информацию см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

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

- name: Get information on all stacks
  amazon.aws.cloudformation_info:
  register: all_stacks_output

- 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'] }}"

# 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 info about a stack but fail if it doesn't exist
  amazon.aws.cloudformation_info:
    stack_name: nonexistent-stack
    all_facts: true
  failed_when: cloudformation['nonexistent-stack'] is undefined

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

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

Ключ

Описание

cloudformation

dictionary

Словарь словарей, содержащий информацию о стеке(ах).

Ключи — это имя(на) стека(ов).

Возвращается: всегда

stack_change_sets

list / elements=string

Список наборов изменений стека. Каждый элемент в списке представляет собой подробную информацию о конкретном наборе изменений.

Возвращается: только если all_facts или stack_policy равно true и стек существует

stack_description

dictionary

Сводная информация о стеке.

Возвращается: если стек существует

capabilities

list / elements=string

Допустимые возможности в стеке.

Возвращается: всегда

creation_time

string

Время создания стека.

Возвращается: если стек существует

deletion_time

string

Время удаления стека.

Возвращается: если стек был удален

description

string

Определенное пользователем описание, связанное со стеком.

Возвращается: всегда

disable_rollback

boolean

Включено ли откат при сбоях создания стека.

Возвращается: всегда

drift_information

dictionary

Информация о том, отличается ли фактическая конфигурация стека от ожидаемой конфигурации, как определено в шаблоне стека и любых значениях, указанных в качестве параметров шаблона.

Возвращается: всегда

last_check_timestamp

string

Последнее время, когда операция обнаружения отклонений была инициирована в стеке или любом из его отдельных ресурсов, поддерживающих обнаружение отклонений.

Возвращается: если обнаружено отклонение

stack_drift_status

string

Статус фактической конфигурации стека по сравнению с ожидаемой конфигурацией шаблона.

Возвращается: всегда

enable_termination_protection

boolean

Включена ли защита от завершения работы для стека.

Возвращается: всегда

notification_arns

list / elements=string

Amazon SNS topic ARN, в которые публикуются события, связанные со стеком.

Возвращается: всегда

outputs

list / elements=dictionary

Список словарей вывода.

Возвращается: всегда

output_key

string

Ключ, связанный с выводом.

Возвращается: всегда

output_value

string

Значение, связанное с выводом.

Возвращается: всегда

parameters

list / elements=dictionary

Список словарей параметров.

Возвращается: всегда

parameter_key

string

Ключ, связанный с параметром.

Возвращается: всегда

parameter_value

string

Значение, связанное с параметром.

Возвращается: всегда

rollback_configuration

dictionary

Триггеры отката, которые CloudFormation отслеживает во время операций создания и обновления стека.

Возвращается: всегда

rollback_triggers

list / elements=dictionary

Триггеры, которые необходимо отслеживать во время создания или обновления стека.

Возвращается: если существуют триггеры отката

arn

string

ARN триггера отката.

Возвращается: всегда

type

string

Тип ресурса триггера отката.

Возвращается: всегда

stack_id

string

Уникальный ID стека.

Возвращается: всегда

stack_name

string

Имя стека.

Возвращается: всегда

stack_status

string

Статус стека.

Возвращается: всегда

tags

list / elements=dictionary

Список тегов, связанных со стеком.

Возвращается: всегда

key

string

Ключ тега.

Возвращается: всегда

value

string

Значение тега.

Возвращается: всегда

stack_events

list / elements=string

Все события стека для данного стека.

Возвращается: только если all_facts или stack_events равно true и стек существует

stack_outputs

dictionary

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

Возвращается: если стек существует

Пример: {"ApplicationDatabaseName": "dazvlpr01xj55a.ap-southeast-2.rds.amazonaws.com"}

stack_parameters

dictionary

Словарь параметров стека, с ключами, соответствующими значению каждого параметра ‘ParameterKey’, и значениями, соответствующими значению каждого параметра ‘ParameterValue’.

Возвращается: если стек существует

Пример: {"DatabaseEngine": "mysql", "DatabasePassword": "***"}

stack_policy

dictionary

Описание политики стека.

Возвращается: только если all_facts или stack_policy равно true и стек существует

stack_resource_list

list / elements=string

Описание ресурсов стека.

Возвращается: только если all_facts или stack_policy равно true и стек существует

stack_resources

dictionary

Словарь ресурсов стека, с ключами, соответствующими значению каждого параметра ‘LogicalResourceId’, и значениями, соответствующими значению каждого параметра ‘PhysicalResourceId’.

Возвращается: только если all_facts или stack_policy равно true и стек существует

Пример: {"ApplicationDatabase": "dazvlpr01xj55a", "AutoScalingGroup": "dev-someapp-AutoscalingGroup-1SKEXXBCAN0S7", "AutoScalingSecurityGroup": "sg-abcd1234"}

stack_tags

dictionary

Словарь пар «ключ-значение» тегов.

Возвращается: только если all_facts или stack_policy равно true и стек существует

Пример: {"TagOne": "ValueOne", "TagTwo": "ValueTwo"}

stack_template

dictionary

Описание шаблона стека.

Возвращается: только если all_facts или stack_policy равно true и стек существует

Авторы

  • Justin Menga (@jmenga)
  • Kevin Coming (@waffie1)

Ссылки на коллекции

  • Отслеживание проблем
  • Репозиторий (источники)
  • Связь

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

Spec-Zone.ru

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