Модуль amazon.aws.cloudformation — создание или удаление стека AWS CloudFormation

access_key

псевдонимы: aws_access_key_id, aws_access_key

string

Идентификатор ключа доступа 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 SDK botocore.

aws_ca_bundle

path

Путь к пакету сертификатов CA, используемому для проверки SSL-сертификатов.

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

aws_config

dictionary

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

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

backoff_delay

integer

Количество секунд ожидания перед следующей повторной попыткой.

По умолчанию: 3

backoff_max_delay

integer

Максимальное время ожидания между повторными попытками.

По умолчанию: 30

backoff_retries

integer

Количество повторных попыток выполнения операции.

Механизм ограничения частоты запросов API AWS приводит к сбою модуля CloudFormation, поэтому операцию необходимо повторить несколько раз.

По умолчанию: 10

capabilities

list / elements=string

Укажите возможности, используемые шаблоном стека.

Допустимые значения: CAPABILITY_IAM, CAPABILITY_NAMED_IAM и CAPABILITY_AUTO_EXPAND.

По умолчанию: ["CAPABILITY_IAM", "CAPABILITY_NAMED_IAM"]

changeset_name

string

Имя, присваиваемое набору изменений при его создании.

Используется только при create_changeset=true.

По умолчанию на основе входных параметров создаётся имя с префиксом Ansible-STACKNAME. Дополнительную информацию см. в документации AWS о наборах изменений: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html

create_changeset

boolean

Если стек уже существует, создаёт набор изменений вместо непосредственного применения изменений. См. документацию AWS о наборах изменений: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html.

ПРЕДУПРЕЖДЕНИЕ: если стек не существует, он будет создан без набора изменений. Если state=absent, стек будет немедленно удалён без набора изменений.

Варианты:

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

create_timeout

integer

Время (в минутах), по истечении которого статус стека станет CREATE_FAILED.

debug_botocore_endpoint_logs

boolean

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

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

Варианты:

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

disable_rollback

boolean

Если создание стека завершится с ошибкой, откат приведёт к удалению стека.

Варианты:

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

endpoint_url

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

string

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

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

events_limit

integer

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

По умолчанию: 200

notification_arns

string

Список ARN тем Simple Notification Service (SNS), разделённых запятыми, для публикации событий, связанных со стеком.

on_create_failure

string

Действие при сбое создания стека. Несовместимо с параметром disable_rollback.

Варианты:

• "DO_NOTHING"
• "ROLLBACK"
• "DELETE"

profile

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

string

Именованный профиль 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

string

Регион AWS для использования.

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

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

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

role_arn

string

Роль, которую AWS CloudFormation использует для создания стека. См. документацию AWS CloudFormation о сервисных ролях: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-servicerole.html

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key

string

Секретный ключ доступа 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 SDK botocore.

session_token

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

string

Токен сеанса 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_name

string / обязательный

Имя стека CloudFormation.

stack_policy

string

Путь к файлу с политикой стека CloudFormation. После установки политику нельзя удалить, но можно изменить. Например, разрешить все обновления: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html#d0e9051

stack_policy_body

json

добавлено в amazon.aws 1.5.0

Политика стека CloudFormation в формате JSON. После установки политику нельзя удалить, но можно изменить. Например, разрешить все обновления: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html#d0e9051

stack_policy_on_update_body

json

добавлено в amazon.aws 1.5.0

Тело политики стека CloudFormation, применяемой только во время этого обновления.

state

string

Если state=present, стек будет создан.

Если state=present и стек существует, а шаблон изменился, стек будет обновлён.

Если state=absent, стек будет удалён.

Варианты:

• "present" ← (по умолчанию)
• "absent"

tags

dictionary

Словарь тегов, связываемых со стеком и его ресурсами при создании стека.

Теги можно обновить позднее; при обновлении тегов предыдущие записи удаляются.

template

path

Локальный путь к шаблону CloudFormation.

Это должен быть полный путь к файлу относительно рабочего каталога. При использовании ролей путь может выглядеть так: roles/cloudformation/files/cloudformation-example.json.

Если state=present и стек ещё не существует, необходимо указать template, template_body или template_url (но только один из этих параметров).

Если state=present, стек существует, а параметры template, template_body и template_url не указаны, будет повторно использован предыдущий шаблон.

Параметр template объявлен устаревшим и будет удалён в выпуске после 2026-05-01. Рекомендуется использовать template_body с плагином поиска ansible.builtin.template.

template_body

string

Тело шаблона. Используйте этот параметр, чтобы передать фактическое тело шаблона CloudFormation.

Если state=present и стек ещё не существует, необходимо указать template, template_body или template_url (но только один из этих параметров).

Если state=present, стек существует, а параметры template, template_body и template_url не указаны, будет повторно использован предыдущий шаблон.

template_parameters

dictionary

Список хешей со всеми переменными шаблона для стека. Значение может быть строкой или словарём.

Словарь можно использовать для задания дополнительных атрибутов параметров шаблона, например UsePreviousValue (см. пример).

По умолчанию: {}

template_url

string

Расположение файла с телом шаблона. URL должен указывать на шаблон (максимальный размер — 307 200 байт), расположенный в корзине S3 в том же регионе, что и стек.

Если state=present и стек ещё не существует, необходимо указать template, template_body или template_url (но только один из этих параметров).

Если state=present, стек существует, а параметры template, template_body и template_url не указаны, будет повторно использован предыдущий шаблон.

termination_protection

boolean

Включить или отключить защиту стека от удаления.

Варианты:

• false
• true

validate_certs

boolean

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

Настоятельно не рекомендуется устанавливать validate_certs=false; вместо этого рассмотрите возможность задать параметр aws_ca_bundle.

Варианты:

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

change_set_id

string

Идентификатор набора изменений стека, созданного при его создании.

Возвращается: когда state=present и create_changeset=true.

Пример: "arn:aws:cloudformation:us-east-1:123456789012:changeSet/Ansible-StackName-f4496805bd1b2be824d1e315c6884247ede41eb0"

events

list / elements=string

Последние события в журнале событий CloudFormation. В некоторых случаях это могут быть события из предыдущего запуска.

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

Пример: ["StackEvent AWS::CloudFormation::Stack stackname UPDATE_COMPLETE", "StackEvent AWS::CloudFormation::Stack stackname UPDATE_COMPLETE_CLEANUP_IN_PROGRESS"]

log

list / elements=string

Журналы отладки. Полезны при внесении изменений или поиске ошибки.

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

Пример: ["updating stack"]

stack_outputs

dictionary

Словарь «ключ:значение» со всеми выходными данными стека, определёнными в данный момент. Если у стека нет выходных данных, возвращается пустой словарь.

Возвращается: когда state=present

Пример: {"MySg": "AnsibleModuleTestYAML-CFTestSg-C8UVS567B6NS"}

stack_resources

list / elements=dictionary

Ресурсы стека AWS и их состояние. Список словарей, по одному словарю на ресурс.

Возвращается: когда state=present

Пример: [{"last_updated_time": "2016-10-11T19:40:14.979000+00:00", "logical_resource_id": "CFTestSg", "physical_resource_id": "cloudformation2-CFTestSg-16UQ4CYQ57O9F", "resource_type": "AWS::EC2::SecurityGroup", "status": "UPDATE_COMPLETE", "status_reason": null}]