community.aws.sqs_queue модуль — Создаёт или удаляет очереди AWS SQS

Примечание

Этот модуль является частью коллекции community.aws (версия 8.0.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля требуется дополнительное ПО, см. Требования для подробностей.

Для использования в плейбуке укажите: community.aws.sqs_queue.

Добавлен в community.aws 1.0.0

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Создаёт или удаляет очереди AWS SQS.
Обновляет атрибуты существующих очередей.

Требования

Ниже приведены требования к хосту, на котором будет выполняться этот модуль.

python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0

Параметры

Параметр	Комментарии
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string	Идентификатор ключа доступа AWS. См. документацию 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_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
aws_ca_bundle path	Расположение пакета CA, используемого при проверке SSL-сертификатов. Переменная среды `AWS_CA_BUNDLE` также может использоваться.
aws_config dictionary	Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
content_based_deduplication boolean	Включает дедупликацию на основе контента. Используется только для FIFOs. По умолчанию `false`. Варианты: `false` `true`
debug_botocore_endpoint_logs boolean	Используйте `botocore.endpoint` регистратор для анализа уникальных (а не общих) `"resource:action"` вызовов API, выполненных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов `aws_resource_action` для вывода в общий список, созданный во время playbook. Переменная среды `ANSIBLE_DEBUG_BOTOCORE_LOGS` также может использоваться. Варианты: `false` ← (по умолчанию) `true`
deduplication_scope string добавлено в community.aws 5.3.0	Область дедупликации для очередей FIFO. `messageGroup` требуется для FIFO с высокой пропускной способностью. По умолчанию `queue` при создании. Варианты: `"queue"` `"messageGroup"`
delay_seconds aliases: delivery_delay integer	Задержка доставки в секундах.
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string	URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с 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 string добавлено в community.aws 5.3.0	Предел пропускной способности для очередей FIFO. `perMessageGroupId` требуется для FIFO с высокой пропускной способностью. По умолчанию `perQueue` при создании. Варианты: `"perQueue"` `"perMessageGroupId"`
kms_data_key_reuse_period_seconds aliases: kms_data_key_reuse_period integer	Продолжительность времени в секундах, в течение которого Amazon SQS может повторно использовать ключ данных для шифрования или дешифрования сообщений, прежде чем снова вызывать AWS KMS.
kms_master_key_id string	Идентификатор управляемого AWS основного ключа клиента (CMK) для Amazon SQS или настраиваемого CMK. Указание допустимого kms_master_key_id автоматически включит шифрование.
maximum_message_size integer	Максимальный размер сообщения в байтах.
message_retention_period integer	Срок хранения сообщений в секундах.
name string / required	Название очереди.
policy dictionary	Политика для присоединения к очереди. Тело политики может быть YAML или JSON. Это необходимо для некоторых случаев использования, например, с уведомлениями о корзине S3.

профиль псевдонимы: aws_profile строка	Используемый профиль AWS для аутентификации. Дополнительную информацию о профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды `AWS_PROFILE`. Параметр профиль взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token.
очистить_метки логическое значение	Если очистить_метки=true и метки задано, существующие метки ресурса будут удалены, чтобы точно соответствовать значениям, определённым параметром метки. Если параметр метки не задан, то метки не будут изменены, даже если очистить_метки=True. Ключи меток, начинающиеся с `aws:`, зарезервированы Amazon и не могут быть изменены. Поэтому они будут игнорироваться для параметра очистить_метки. Дополнительную информацию см. в документации Amazon https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions. Варианты: `false` `true` ← (по умолчанию)
тип_ очереди строка	Очередь Standard или FIFO. тип_очереди может быть установлен только при создании очереди и в противном случае будет проигнорирован. Варианты: `"standard"` ← (по умолчанию) `"fifo"`
время_ожидания_получения_сообщения псевдонимы: время_ожидания_получения_сообщения целое число	Время ожидания получения сообщения в секундах.
политика_перенаправления словарь	Словарь JSON с политикой перенаправления (см. пример).
регион псевдонимы: aws_region, ec2_region строка	Регион AWS для использования. Для глобальных служб, таких как IAM, Route53 и CloudFront, регион игнорируется. Также можно использовать переменные среды `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.
секретный_ключ псевдонимы: 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` в порядке убывания приоритета. Параметры секретный_ключ и профиль взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK botocore AWS. Псевдоним ec2_secret_key устарел и будет удален после 2024-12-01. Поддержка переменной среды `EC2_SECRET_KEY` устарела и будет удалена после 2024-12-01.
токен_сессии псевдонимы: 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` в порядке убывания приоритета. Параметры токен_сессии и профиль взаимоисключающие. Псевдонимы aws_session_token и токен_сессии были добавлены в релизе 3.2.0, параметр был переименован из security_token в токен_сессии в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены после 2024-12-01. Поддержка переменных среды `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена после 2024-12-01.
состояние строка	Создать или удалить очередь. Варианты: `"present"` ← (по умолчанию) `"absent"`
метки псевдонимы: метки_ресурса словарь	Словарь, представляющий метки, которые должны быть применены к ресурсу. Если параметр метки не задан, то метки не будут изменены.
проверять_сертификаты логическое значение	Если установлено значение `false`, сертификаты SSL для связи с API AWS не будут проверены. Установка проверять_сертификаты=false категорически не рекомендуется. В качестве альтернативы, установите aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
тайм_аут_видимости псевдонимы: тайм_аут_видимости_по_умолчанию целое число	Значение тайм-аута видимости по умолчанию в секундах.

Примечания

Примечание

Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не «контроллер». Таким образом, файлы могут потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не «хост» контекста.
AWS SDK (boto3), который использует Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте 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

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
content_based_deduplication boolean	Включает дедупликацию на основе содержимого. Используется только для FIFO. Возвращается: всегда Пример: `true`
deduplication_scope string	Настройка дедупликации. Возвращается: всегда Пример: `"messageGroup"`
delay_seconds integer	Задержка доставки в секундах. Возвращается: всегда Пример: `0`
fifo_throughput_limit string	Стратегия ограничения пропускной способности. Возвращается: всегда Пример: `"perQueue"`
kms_data_key_reuse_period_seconds integer	Продолжительность времени в секундах, в течение которого Amazon SQS может повторно использовать ключ данных для шифрования или расшифровки сообщений перед повторным обращением к AWS KMS. Возвращается: всегда Пример: `300`
kms_master_key_id string	Идентификатор управляемого AWS основного ключа клиента (CMK) для Amazon SQS или пользовательского CMK. Возвращается: если значение существует Пример: `"alias/MyAlias"`
maximum_message_size integer	Максимальный размер сообщения в байтах. Возвращается: всегда Пример: `262144`
message_retention_period integer	Период хранения сообщений в секундах. Возвращается: всегда Пример: `345600`
name string	Имя очереди SQS Возвращается: всегда Пример: `"queuename-987d2de0"`
queue_arn string	Универсальное имя ресурса (ARN) очереди. Возвращается: при успехе Пример: `"arn:aws:sqs:us-east-1:123456789012:queuename-987d2de0"`
queue_url string	URL для доступа к очереди Возвращается: при успехе Пример: `"https://queue.amazonaws.com/123456789012/MyQueue"`
receive_message_wait_time_seconds integer	Время ожидания получения сообщения в секундах. Возвращается: всегда Пример: `0`
region string	Регион, в котором была создана очередь Возвращается: всегда Пример: `"us-east-1"`
tags dictionary	Список тегов очереди Возвращается: всегда Пример: `{"Env": "prod"}`
visibility_timeout integer	Таймаут видимости по умолчанию в секундах. Возвращается: всегда Пример: `30`

Авторы

Alan Loi (@loia)
Fernando Jose Pando (@nand0p)
Nadir Lloret (@nadirollo)
Dennis Podkovyrin (@sbj-ss)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/sqs_queue_module.html