community.aws.mq_broker 模块 – MQ 代理管理

注意

此模块是 community.aws 集合（版本 9.0.0）的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.aws。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

要在剧本中使用它，请指定：community.aws.mq_broker。

community.aws 6.0.0 中的新增功能

概要 

创建/更新/删除代理。
重启代理。

要求 

在执行此模块的主机上需要满足以下要求。

python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0

参数 

参数	注释
access_key 别名：aws_access_key_id，aws_access_key，ec2_access_key 字符串	AWS 访问密钥 ID。有关访问令牌的更多信息，请参阅 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 botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已弃用，将在 2024-12-01 之后的版本中删除。对 `EC2_ACCESS_KEY` 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
authentication_strategy 字符串	在本地和远程管理的用户之间进行选择。选项 `"SIMPLE"` `"LDAP"`
auto_minor_version_upgrade 布尔值	允许/禁止自动小版本升级。选项 `假` `true` ←（默认）
aws_ca_bundle 路径	用于验证 SSL 证书的 CA 包的位置。也可以使用 `AWS_CA_BUNDLE` 环境变量。
aws_config 字典	用于修改 botocore 配置的字典。可以在 AWS 文档中找到参数 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。
broker_name 字符串 / 必需	要操作的 MQ 代理的名称。
debug_botocore_endpoint_logs 布尔值	使用 `botocore.endpoint` 记录器来解析任务期间进行的唯一（而不是总计）`"resource:action"` API 调用，并将集合输出到任务结果中的 resource_actions 键。使用 `aws_resource_action` 回调输出剧本期间进行的总列表。也可以使用 `ANSIBLE_DEBUG_BOTOCORE_LOGS` 环境变量。选项 `false` ←（默认） `true`
deployment_mode 字符串	设置代理部署类型。只能在创建期间使用。默认为 `SINGLE_INSTANCE`。选项 `"SINGLE_INSTANCE"` `"ACTIVE_STANDBY_MULTI_AZ"` `"CLUSTER_MULTI_AZ"`
enable_audit_log 布尔值	启用/禁用将审计日志推送到 AWS CloudWatch。选项 `false` ←（默认） `true`
enable_general_log 布尔值	启用/禁用将常规日志推送到 AWS CloudWatch。选项 `false` ←（默认） `true`
endpoint_url 别名：ec2_url，aws_endpoint_url，s3_url 字符串	连接到而非默认 AWS 端点的 URL。虽然这可用于连接到其他 AWS 兼容服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。也可以使用 `AWS_URL` 或 `EC2_URL` 环境变量，优先级依次降低。 ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的版本中删除。对 `EC2_URL` 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
engine_type 字符串	设置代理引擎类型。只能在创建期间使用。默认为 `ACTIVEMQ`。选项 `"ACTIVEMQ"` `"RABBITMQ"`
engine_version 字符串	设置代理的引擎版本。特殊值 `latest` 将选择最新的可用版本。特殊值 `latest` 在更新时将被忽略。
host_instance_type 字符串	代理实例的实例类型。
kms_key_id 字符串	使用引用的密钥加密静态代理数据。只能在创建期间使用。
maintenance_window_start_time 字典	设置自动次要升级的维护窗口。只能在创建期间使用。不提供任何值意味着“没有维护窗口”。
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 选项互斥。
publicly_accessible 布尔值	允许/禁止公共访问。只能在创建期间使用。默认为 `false`。选项 `假` `true`
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 botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。 ec2_secret_key 别名已被弃用，将在 2024-12-01 之后的版本中删除。对 `EC2_SECRET_KEY` 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
security_groups list / elements=string	将安全组与 broker 关联。创建期间必须至少提供一个。
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 版本中添加，该参数在 6.0.0 版本中从 security_token 重命名为 session_token。 security_token、aws_security_token 和 access_token 别名已被弃用，将在 2024-12-01 之后的版本中删除。对 `EC2_SECRET_KEY` 和 `AWS_SECURITY_TOKEN` 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
state 字符串	`present`: 创建/更新 broker。 `absent`: 删除 broker。 `restarted`: 重启 broker。选项 `"present"` ← (默认) `"absent"` `"restarted"`
storage_type 字符串	设置底层存储类型。只能在创建期间使用。默认为 `EFS`。选项 `"EBS"` `"EFS"`
subnet_ids list / elements=string	定义将 broker 实例部署到何处。所需的最小数量取决于部署类型。只能在创建期间使用。
tags 字典	标记新创建的 broker。只能在创建期间使用。
use_aws_owned_key 布尔值	如果也提供了 kms_key_id，则必须设置为 `false`。只能在创建期间使用。默认为 `true`。选项 `假` `true`
users list / elements=dictionary	此参数允许使用自定义的初始用户集。 community.aws.mq_user 是管理（本地）用户的首选方式，但是如果没有用户，则无法创建 broker。如果未指定任何内容，则将使用 broker 创建默认的 `admin` 用户。只能在创建期间使用。使用 community.aws.mq_user 模块进行更新。
validate_certs 布尔值	当设置为 `false` 时，将不会验证与 AWS API 通信的 SSL 证书。强烈建议不要设置 validate_certs=false，作为替代方法，请考虑设置 aws_ca_bundle。选项 `假` `true` ←（默认）
wait 布尔值在 community.aws 7.1.0 中添加	指定模块是否等待所需的 `state`。等待时间可以通过设置 wait_timeout 来控制。选项 `false` ←（默认） `true`
wait_timeout integer 在 community.aws 7.1.0 中添加	如果 wait=true，则等待 broker 达到所需状态的时间（以秒为单位）。默认值: `900`

注释 

注意

注意: 对于模块，环境变量和配置文件是从 Ansible “主机” 上下文而不是 “控制器” 上下文读取的。因此，可能需要将文件显式复制到 “主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible “控制器” 上下文而不是 “主机” 上下文读取的。
Ansible 使用的 AWS SDK (boto3) 也可能会从 Ansible “主机” 上下文中的配置文件（通常是 ~/.aws/credentials）读取凭据和其他设置（例如区域）的默认值。有关更多信息，请参见 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例 

- name: create broker (if missing) with minimal required parameters
  community.aws.mq_broker:
    broker_name: "{{ broker_name }}"
    security_groups:
      - sg_xxxxxxx
    subnet_ids:
      - subnet_xxx
      - subnet_yyy
    register: result

- set_fact:
    broker_id: "{{ result.broker['BrokerId'] }}"

- name: use mq_broker_info to wait until broker is ready
  community.aws.mq_broker_info:
    broker_id: "{{ broker_id }}"
  register: result
  until: "result.broker['BrokerState'] == 'RUNNING'"
  retries: 15
  delay: 60

- name: create or update broker with almost all parameter set including credentials
  community.aws.mq_broker:
    broker_name: "my_broker_2"
    state: present
    deployment_mode: 'ACTIVE_STANDBY_MULTI_AZ'
    use_aws_owned_key: false
    kms_key_id: 'my-precreted-key-id'
    engine_type: 'ACTIVEMQ'
    maintenance_window_start_time:
      DayOfWeek: 'MONDAY'
      TimeOfDay: '03:15'
      TimeZone: 'Europe/Berlin'
    publicly_accessible: true
    storage_type: 'EFS'
    security_groups:
      - sg_xxxxxxx
    subnet_ids:
      - subnet_xxx
      - subnet_yyy
    users:
      - Username: 'initial-user'
        Password': 'plain-text-password'
        ConsoleAccess: true
    tags:
      env: Test
      creator: ansible
    authentication_strategy: 'SIMPLE'
    auto_minor_version_upgrade: true
    engine_version: "5.15.13"
    host_instance_type: 'mq.t3.micro'
    enable_audit_log: true
    enable_general_log: true

- name: reboot a broker
  community.aws.mq_broker:
    broker_name: "my_broker_2"
    state: restarted

- name: delete a broker
  community.aws.mq_broker:
    broker_name: "my_broker_2"
    state: absent

返回值 

常见的返回值在此处记录此处，以下是此模块特有的字段

键	描述
broker 字典	所有 API 响应都转换为蛇形 YAML，除了“Tags” “state=present”：create_broker() 或 update_broker() 调用的 API 响应 “state=absent”：在触发 delete_broker() 之前 describe_broker() 调用的结果 “state=restarted”：在触发重启后 describe_broker() 的结果返回: 成功

作者

FCO (@fotto)