community.aws.mq_broker_config модуль — Обновление конфигурации брокера Amazon MQ
Примечание
Этот модуль является частью коллекции community.aws (версия 8.0.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.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 и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
aws_ca_bundle путь | Расположение набора сертификатов CA для проверки сертификатов SSL. Также можно использовать переменную среды |
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 логический тип | Использовать Также можно использовать переменную среды Варианты:
|
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка | URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим службам, совместимым с AWS, коллекции amazon.aws и community.aws протестированы только с AWS. Также можно использовать переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
profile псевдонимы: aws_profile строка | Используемый профиль AWS с заданным именем для аутентификации. Дополнительную информацию о профилях с именами см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token. |
reboot логический тип | Перезагрузить брокер после применения новой конфигурации. Варианты:
|
region псевдонимы: aws_region, ec2_region строка | AWS регион для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, region игнорируется. Также можно использовать переменные среды См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
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. Также можно использовать переменные среды Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string | Токен сессии AWS STS для использования с временными учетными данными. См. документацию AWS для получения дополнительной информации об access token https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут использоваться переменные среды Параметры 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. Поддержка переменных среды |
validate_certs boolean | Если установлено в Установка validate_certs=false крайне не рекомендуется. В качестве альтернативы, рассмотрите возможность настройки aws_ca_bundle вместо этого. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не «контроллер». Поэтому файлы могут потребоваться явно скопировать на «хост». Для плагинов поиска и соединения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не «хост».
- AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте 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() преобразованный в snake yaml после применения изменений. Возвращаемое значение: успех |
configuration сложное | Подробная информация о новом объекте конфигурации. Возвращаемое значение: changed=true |
|
id строка |
Идентификатор конфигурации брокера. Возвращаемое значение: успех Пример: |
|
revision целое число |
Ревизия конфигурации, которая будет активна после следующей перезагрузки. Возвращаемое значение: успех Пример: |
Ссылки на коллекцию
© 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/community/aws/mq_broker_config_module.html
