community.aws.sqs_queue 模块 – 创建或删除 AWS SQS 队列

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.aws。 您需要进一步的要求才能使用此模块，请参阅 要求 获取详细信息。

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

community.aws 1.0.0 中的新增功能

概要

• 创建或删除 AWS SQS 队列。

• 更新现有队列的属性。

要求

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

• 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。
content_based_deduplication 布尔值	启用基于内容的重复数据删除。 仅用于 FIFO。 默认为 false。 选项 false true
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器解析任务期间进行的唯一（而不是总数）"resource:action" API 调用，将集合输出到任务结果中的 resource_actions 键。 使用 aws_resource_action 回调输出到 playbook 期间生成的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ←（默认） true
deduplication_scope 字符串 在 community.aws 5.3.0 中添加	FIFO 队列的重复数据删除范围。 高吞吐量 FIFO 需要 messageGroup。 在创建时默认为 queue。 选项 "queue" "messageGroup"
delay_seconds 别名：delivery_delay 整数	交付延迟（以秒为单位）。
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 之后的版本中删除。
fifo_throughput_limit 字符串 在 community.aws 5.3.0 中添加	FIFO 队列的吞吐量限制。 高吞吐量 FIFO 需要 perMessageGroupId。 在创建时默认为 perQueue。 选项 "perQueue" "perMessageGroupId"
kms_data_key_reuse_period_seconds 别名：kms_data_key_reuse_period 整数	Amazon SQS 可以重用数据密钥来加密或解密消息（在再次调用 AWS KMS 之前）的时间长度（以秒为单位）。
kms_master_key_id 字符串	用于 Amazon SQS 的 AWS 管理的客户主密钥 (CMK) 或自定义 CMK 的 ID。 指定有效的 kms_master_key_id 将自动启用加密。
maximum_message_size 整数	最大消息大小（以字节为单位）。
message_retention_period 整数	消息保留期（以秒为单位）。
name 字符串 / 必需	队列的名称。
policy 字典	要附加到队列的策略。 策略主体可以是 YAML 或 JSON。 对于某些用例（例如 S3 存储桶通知）是必需的。
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 选项互斥。
purge_tags 布尔值	如果设置了 purge_tags=true 并且设置了 tags，则现有标签将从资源中清除，以完全匹配 tags 参数的定义。 如果未设置 tags 参数，则即使设置了 purge_tags=True，标签也不会被修改。 以 aws: 开头的标签键由 Amazon 保留，无法修改。因此，为了 purge_tags 参数的目的，它们将被忽略。有关更多信息，请参阅 Amazon 文档 https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions。 选项 false true ← (默认)
queue_type 字符串	标准队列或 FIFO 队列。 queue_type 只能在队列创建时设置，否则将被忽略。 选项 "standard" ← (默认) "fifo"
receive_message_wait_time_seconds 别名: receive_message_wait_time 整数	接收消息等待时间（以秒为单位）。
redrive_policy 字典	带有 redrive_policy 的 JSON 字典（请参见示例）。
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 secret access key。 有关访问令牌的更多信息，请参阅 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_secret_access_key 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 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 版本中添加，参数名称从 security_token 重命名为 session_token 在 6.0.0 版本中。 security_token、aws_security_token 和 access_token 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
state 字符串	创建或删除队列。 选项 "present" ← (默认) "absent"
tags 别名: resource_tags 字典	一个表示要应用于资源的标签的字典。 如果未设置 tags 参数，则不会修改标签。
validate_certs 布尔值	设置为 false 时，与 AWS API 通信时将不验证 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)
visibility_timeout 别名: default_visibility_timeout 整数	默认可见性超时（以秒为单位）。

注意

注意

• 注意： 对于模块，环境变量和配置文件是从 Ansible “主机” 上下文读取的，而不是从“控制器”上下文读取的。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible “控制器” 上下文读取的，而不是从“主机”上下文读取的。

• Ansible 使用的 AWS SDK (boto3) 也可能会从 Ansible “主机” 上下文中的配置文件（通常是 ~/.aws/credentials）读取凭据和其他设置的默认值，例如区域。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

- name: Create SQS queue with redrive policy
  community.aws.sqs_queue:
    name: my-queue
    region: ap-southeast-2
    default_visibility_timeout: 120
    message_retention_period: 86400
    maximum_message_size: 1024
    delivery_delay: 30
    receive_message_wait_time: 20
    policy: "{{ json_dict }}"
    redrive_policy:
      maxReceiveCount: 5
      deadLetterTargetArn: arn:aws:sqs:eu-west-1:123456789012:my-dead-queue

- name: Drop redrive policy
  community.aws.sqs_queue:
    name: my-queue
    region: ap-southeast-2
    redrive_policy: {}

- name: Create FIFO queue
  community.aws.sqs_queue:
    name: fifo-queue
    region: ap-southeast-2
    queue_type: fifo
    content_based_deduplication: true

- name: Tag queue
  community.aws.sqs_queue:
    name: fifo-queue
    region: ap-southeast-2
    tags:
      example: SomeValue

- name: Configure Encryption, automatically uses a new data key every hour
  community.aws.sqs_queue:
    name: fifo-queue
    region: ap-southeast-2
    kms_master_key_id: alias/MyQueueKey
    kms_data_key_reuse_period_seconds: 3600

- name: Example queue allowing s3 bucket notifications
  sqs_queue:
    name: "S3Notifications"
    default_visibility_timeout: 120
    message_retention_period: 86400
    maximum_message_size: 1024
    delivery_delay: 30
    receive_message_wait_time: 20
    policy:
      Version: 2012-10-17
      Id: s3-queue-policy
      Statement:
        - Sid: allowNotifications
          Effect: Allow
          Principal:
            Service: s3.amazonaws.com
          Action:
            - SQS:SendMessage
          Resource: "arn:aws:sqs:*:*:S3Notifications"
          Condition:
            ArnLike:
              aws:SourceArn: "arn:aws:s3:*:*:SomeBucket"

- name: Delete SQS queue
  community.aws.sqs_queue:
    name: my-queue
    region: ap-southeast-2
    state: absent

返回值

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

Key	描述
content_based_deduplication 布尔值	启用基于内容的重复数据删除。 仅用于 FIFO。 Returned: always Sample: true
deduplication_scope 字符串	重复数据删除设置。 Returned: always Sample: "messageGroup"
delay_seconds 整数	交付延迟（以秒为单位）。 Returned: always Sample: 0
fifo_throughput_limit 字符串	应用哪种吞吐量限制策略。 Returned: always Sample: "perQueue"
kms_data_key_reuse_period_seconds 整数	Amazon SQS 可以重用数据密钥来加密或解密消息（在再次调用 AWS KMS 之前）的时间长度（以秒为单位）。 Returned: always Sample: 300
kms_master_key_id 字符串	用于 Amazon SQS 的 AWS 管理的客户主密钥 (CMK) 或自定义 CMK 的 ID。 Returned: if value exists Sample: "alias/MyAlias"
maximum_message_size 整数	最大消息大小（以字节为单位）。 Returned: always Sample: 262144
message_retention_period 整数	消息保留期（以秒为单位）。 Returned: always Sample: 345600
name 字符串	SQS 队列的名称 Returned: always Sample: "queuename-987d2de0"
queue_arn 字符串	队列的 Amazon 资源名称 (ARN)。 Returned: on success Sample: "arn:aws:sqs:us-east-1:123456789012:queuename-987d2de0"
queue_url 字符串	访问队列的 URL Returned: on success Sample: "https://queue.amazonaws.com/123456789012/MyQueue"
receive_message_wait_time_seconds 整数	接收消息等待时间（以秒为单位）。 Returned: always Sample: 0
region 字符串	创建队列所在的区域 Returned: always Sample: "us-east-1"
tags 字典	队列标签列表 Returned: always Sample: {"Env": "prod"}
visibility_timeout 整数	默认可见性超时（以秒为单位）。 Returned: always Sample: 30

作者

• Alan Loi (@loia)

• Fernando Jose Pando (@nand0p)

• Nadir Lloret (@nadirollo)

• Dennis Podkovyrin (@sbj-ss)

集合链接

• 问题跟踪器
• 存储库（源代码）
• 通信