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 队列的重复数据删除范围。 messageGroup 是高吞吐量 FIFO 的必备项。 创建时默认为 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密钥访问密钥。 有关访问令牌的更多信息，请参阅 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之后的一个版本中移除。
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选项互斥。 在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之后的一个版本中移除。 对环境变量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。 返回：始终 示例：true
deduplication_scope 字符串	去重设置。 返回：始终 示例："messageGroup"
delay_seconds 整数	以秒为单位的传递延迟。 返回：始终 示例：0
fifo_throughput_limit 字符串	应用了哪种吞吐量限制策略。 返回：始终 示例："perQueue"
kms_data_key_reuse_period_seconds 整数	Amazon SQS在再次调用AWS KMS之前，可以重用数据密钥来加密或解密消息的时间长度（以秒为单位）。 返回：始终 示例：300
kms_master_key_id 字符串	Amazon SQS的AWS托管客户主密钥 (CMK) 或自定义 CMK 的 ID。 返回值：如果值存在 示例： "alias/MyAlias"
maximum_message_size 整数	最大消息大小（以字节为单位）。 返回：始终 示例： 262144
message_retention_period 整数	消息保留期（以秒为单位）。 返回：始终 示例： 345600
name 字符串	SQS队列名称 返回：始终 示例： "queuename-987d2de0"
queue_arn 字符串	队列的Amazon资源名称 (ARN)。 返回值：成功时 示例： "arn:aws:sqs:us-east-1:123456789012:queuename-987d2de0"
queue_url 字符串	访问队列的URL 返回值：成功时 示例： "https://queue.amazonaws.com/123456789012/MyQueue"
receive_message_wait_time_seconds 整数	接收消息等待时间（以秒为单位）。 返回：始终 示例：0
region 字符串	创建队列的区域 返回：始终 示例： "us-east-1"
tags 字典	队列标签列表 返回：始终 示例： {"Env": "prod"}
visibility_timeout 整数	默认可见性超时时间（以秒为单位）。 返回：始终 示例： 30

作者

• Alan Loi (@loia)

• Fernando Jose Pando (@nand0p)

• Nadir Lloret (@nadirollo)

• Dennis Podkovyrin (@sbj-ss)

相关链接

• 问题追踪器
• 代码仓库
• 沟通