community.aws.mq_user 模块 – 管理现有 Amazon MQ 代理中的用户
注意
此模块是 community.aws 集合 (版本 9.0.0) 的一部分。
如果您使用的是 ansible
包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install community.aws
。您需要其他要求才能使用此模块,有关详细信息,请参阅 要求。
要在剧本中使用它,请指定:community.aws.mq_user
。
community.aws 6.0.0 中的新增功能
概要
管理 Amazon MQ 用户。
挂起的更改将被考虑在内以实现幂等性。
要求
在执行此模块的主机上需要以下要求。
python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0
参数
参数 |
注释 |
---|---|
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 和 profile 选项是互斥的。 aws_access_key_id 别名在 5.1.0 版本中添加,以与 AWS botocore SDK 保持一致。 ec2_access_key 别名已被弃用,将在 2024-12-01 后的某个版本中移除。
|
|
当 allow_pw_update=true 且设置了 password 时,将始终更新用户的密码。 选项
|
|
验证 SSL 证书时要使用的 CA 捆绑包的位置。 也可以使用 |
|
用于修改 botocore 配置的字典。 参数可在 AWS 文档中找到 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。 |
|
要操作的 MQ 代理的 ID。 |
|
用户是否可以访问 MQ 控制台。 创建时默认为 选项
|
|
使用 也可以使用 选项
|
|
连接到默认 AWS 端点以外的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务,但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 也可以使用 ec2_url 和 s3_url 别名已被弃用,将在 2024-12-01 后的某个版本中移除。 对环境变量 |
|
设置用户的组成员资格。 创建时默认为 |
|
设置用户的密码。 创建时默认为随机密码。 除非allow_pw_update=true,否则将被忽略。 |
|
用于身份验证的命名AWS配置文件。 有关命名配置文件的更多信息,请参见AWS文档https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 也可以使用 profile选项与aws_access_key、aws_secret_key和security_token选项互斥。 |
|
要使用的AWS区域。 对于IAM、Route53和CloudFront等全局服务,将忽略region。 也可以使用 有关更多信息,请参见Amazon AWS文档http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。 别名 对环境变量 |
|
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 botocore SDK保持一致,在5.1.0版本中添加了aws_secret_access_key别名。 别名ec2_secret_key已弃用,将在2024-12-01之后的一个版本中移除。 对环境变量 |
|
用于临时凭据的AWS STS会话令牌。 有关访问令牌的更多信息,请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 security_token和profile选项互斥。 在3.2.0版本中添加了aws_session_token和session_token别名,在6.0.0版本中将参数名称从security_token重命名为session_token。 别名security_token、aws_security_token和access_token已弃用,将在2024-12-01之后的一个版本中移除。 对环境变量 |
|
创建/更新与删除用户。 选项
|
|
要创建/更新/删除的用户名。 |
|
设置为 强烈建议不要设置validate_certs=false,作为替代方案,请考虑设置aws_ca_bundle。 选项
|
备注
注意
注意:对于模块,环境变量和配置文件是从Ansible的“主机”上下文而不是“控制器”上下文读取的。因此,可能需要将文件显式复制到“主机”。对于查找和连接插件,环境变量和配置文件是从Ansible的“控制器”上下文而不是“主机”上下文读取的。
Ansible使用的AWS SDK (boto3)也可能从Ansible“主机”上下文(通常为
~/.aws/credentials
)中的配置文件读取凭据和其他设置的默认值,例如区域。有关更多信息,请参见https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。
示例
- name: create/update user - set provided password if user doesn't exist, yet
community.aws.mq_user:
state: present
broker_id: "aws-mq-broker-id"
username: "sample_user1"
console_access: false
groups: ["g1", "g2"]
password: "plain-text-password"
- name: allow console access and update group list - relying on default state
community.aws.mq_user:
broker_id: "aws-mq-broker-id"
username: "sample_user1"
region: "{{ aws_region }}"
console_access: true
groups: ["g1", "g2", "g3"]
- name: remove user - setting all credentials explicitly
community.aws.mq_user:
state: absent
broker_id: "aws-mq-broker-id"
username: "other_user"
返回值
常见的返回值已在此处记录,以下是此模块特有的字段
键 |
描述 |
---|---|
仅回显用户名 仅在state=present时出现 返回值:success |