Модуль community.aws.mq_broker_config — обновление конфигурации брокера Amazon MQ

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.aws.mq_broker_config.

Добавлено в community.aws 6.0.0

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

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

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

Требования

На хосте, где выполняется этот модуль, необходимы следующие компоненты.

python >= 3.6
boto3 >= 1.34.0
botocore >= 1.34.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 SDK botocore.
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.
broker_id строка / обязательный	Идентификатор брокера MQ, с которым нужно работать.
config_description строка	Описание для новой версии конфигурации.
config_xml строка / обязательный	Максимальное количество возвращаемых результатов.
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.
reboot логическое значение	Перезагрузить брокер после применения новой конфигурации. Варианты: `false` ← (по умолчанию) `true`
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 SDK botocore.
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 являются взаимоисключающими.
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.

Примеры

- name: send new XML config to broker relying on credentials from environment
  community.aws.mq_broker_config:
    broker_id: "aws-mq-broker-id"
    config_xml: "{{ lookup('file', 'activemq.xml' )}}"
    region: "{{ aws_region }}"

- name: send new XML config to broker and reboot if necessary
  community.aws.mq_broker_config:
    broker_id: "aws-mq-broker-id"
    config_xml: "{{ lookup('file', 'activemq2.xml' )}}"
    reboot: true

- name: send new broker config and set all credentials explicitly
  community.aws.mq_broker_config:
    broker_id: "{{ broker_id }}"
    config_xml: "{{ lookup('file', 'activemq3.xml')}}"
    config_description: "custom description for configuration object"
    register: result

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

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

Ключ	Описание
broker словарь	Ответ API describe_broker(), преобразованный в YAML со snake_case после применения изменений. Возвращается: success
configuration сложный тип	Сведения о новом объекте конфигурации. Возвращается: changed=true
id строка	Идентификатор конфигурации брокера. Возвращается: success Пример: `"c-386541b8-3139-42c2-9c2c-a4c267c1714f"`
revision целое число	Версия конфигурации, которая будет активна после следующей перезагрузки. Возвращается: success Пример: `4`

Авторы

FCO (@fotto)

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

© 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/community/aws/mq_broker_config_module.html