community.aws.msk_config 模块 – 管理 Amazon MSK 集群配置

注意

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

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

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

要在 playbook 中使用它，请指定： community.aws.msk_config。

community.aws 2.0.0 中的新增功能

概要 

创建、删除和修改 Amazon MSK（Apache Kafka 的托管流）集群配置。
在 5.0.0 版本之前，此模块称为 community.aws.aws_msk_config。使用方法没有改变。

别名：aws_msk_config

要求 

执行此模块的主机需要以下要求。

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 后的某个版本中删除。
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。
config 别名：configuration 字典	server.properties 文件的内容。默认值： `{}`
debug_botocore_endpoint_logs 布尔值	使用 `botocore.endpoint` 日志记录器来解析在任务期间进行的唯一（而不是总计）`"resource:action"` API 调用，并将集合输出到任务结果中的 resource_actions 密钥。使用 `aws_resource_action` 回调将输出到 playbook 期间进行的总列表。也可以使用 `ANSIBLE_DEBUG_BOTOCORE_LOGS` 环境变量。选项 `false` ← (默认) `true`
description 字符串	配置的描述。默认值： `""`
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 后的某个版本中删除。
kafka_versions 列表 / 元素=字符串	您可以使用此 MSK 配置的 Apache Kafka 版本。当 state=present 时，这是必需的。
name 字符串 / 必需	配置的名称。
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选项互斥。
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保持一致，别名aws_secret_access_key在5.1.0版本中添加。别名ec2_secret_key已弃用，将在2024-12-01之后发布的版本中移除。对`EC2_SECRET_KEY`环境变量的支持已弃用，将在2024-12-01之后发布的版本中移除。
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`）或删除（`absent`）集群配置。选项 `"present"` ← (默认) `"absent"`
validate_certs 布尔值	设置为`false`时，将不会验证与AWS API通信的SSL证书。强烈建议不要设置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。

示例 

# Note: These examples do not set authentication details, see the AWS Guide for details.

- community.aws.msk_config:
    name: kafka-cluster-configuration
    state: present
    kafka_versions:
      - 2.6.0
      - 2.6.1
    config:
      auto.create.topics.enable: false
      num.partitions: 1
      default.replication.factor: 3
      zookeeper.session.timeout.ms: 18000

- community.aws.msk_config:
    name: kafka-cluster-configuration
    state: absent

返回值 

常用的返回值已在此处记录，以下是此模块独有的字段

键	描述
arn 字符串	配置的Amazon资源名称 (ARN)。返回： state=present 示例： `"arn:aws:kafka:<region>:<account>:configuration/<name>/<resource-id>"`
response 字典	实际API调用的响应。返回：始终返回示例： `{}`
revision 整数	修订号。返回： state=present 示例： `1`
server_properties 字符串	server.properties 文件的内容。返回： state=present 示例： `"default.replication.factor=3\nnum.io.threads=8\nzookeeper.session.timeout.ms=18000"`

作者

Daniil Kupchenko (@oukooveu)