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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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.35.0
botocore >= 1.35.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_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` в порядке убывания предпочтения. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK.
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` для анализа уникальных (а не общего количества) вызовов API `"resource:action"`, выполненных во время задачи, и сохранять их список в ключе resource_actions в результатах задачи. Используйте обработчик обратного вызова `aws_resource_action`, чтобы вывести полный список вызовов, выполненных во время плейбука. Также можно использовать переменную окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Возможные значения: `false` ← (по умолчанию) `true`
endpoint_url псевдоним: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения `AWS_URL`.
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 и session_token.
region псевдоним: aws_region строка	Регион AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную окружения `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
secret_key псевдонимы: aws_secret_access_key, aws_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` в порядке убывания предпочтения. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK.
session_token псевдоним: aws_session_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`. Параметры session_token и profile являются взаимоисключающими.
stack_change_sets логическое значение	Получать наборы изменений стека. Возможные значения: `false` ← (по умолчанию) `true`
stack_events логическое значение	Получать события стека. Возможные значения: `false` ← (по умолчанию) `true`
stack_name строка	Имя или идентификатор стека CloudFormation. По умолчанию собирается информация обо всех стеках.
stack_policy логическое значение	Получать политику стека. Возможные значения: `false` ← (по умолчанию) `true`
stack_resources логическое значение	Получать ресурсы стека. Возможные значения: `false` ← (по умолчанию) `true`
stack_template логическое значение	Получать тело шаблона стека. Возможные значения: `false` ← (по умолчанию) `true`
validate_certs логическое значение	Если задано значение `false`, SSL-сертификаты не будут проверяться при взаимодействии с API AWS. Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рекомендуется указать aws_ca_bundle. Возможные значения: `false` `true` ← (по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные окружения и файлы конфигурации считываются в контексте «узла» Ansible, а не в контексте «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются в контексте «контроллера» Ansible, а не в контексте «узла».
Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте «узла» 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_name. Возвращается: всегда
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	ARN тем Amazon SNS, в которые публикуются события, связанные со стеком. Возвращается: всегда
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	Уникальный идентификатор стека. Возвращается: всегда
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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/cloudformation_info_module.html