Spec-Zone.ru › Ansible

Модуль community.aws.sqs_queue — создание и удаление очередей AWS SQS

Примечание

Этот модуль входит в коллекцию community.aws (версия 10.1.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.34.0
  • botocore >= 1.34.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key

строка

Идентификатор ключа доступа 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 (в порядке убывания приоритета).

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для единообразия с AWS SDK botocore.

aws_ca_bundle

путь

Расположение пакета сертификатов CA, используемого для проверки SSL-сертификатов.

Также можно использовать переменную среды 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 для анализа уникальных (а не общих) вызовов API "resource:action", выполненных во время задачи, и выводить полученный набор в ключ resource_actions результатов задачи. Используйте обработчик aws_resource_action, чтобы вывести общий список вызовов, выполненных во время плейбука.

Также можно использовать переменную среды 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

псевдонимы: aws_endpoint_url

строка

URL-адрес для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws тестируются только с AWS.

Также можно использовать переменную среды AWS_URL.

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

строка

Идентификатор управляемого AWS главного ключа клиента (CMK) для Amazon SQS или пользовательского CMK.

Указание допустимого значения 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 и session_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

словарь

Словарь JSON с redrive_policy (см. пример).

region

псевдонимы: aws_region

строка

Регион AWS, который следует использовать.

Для глобальных служб, таких как IAM, Route53 и CloudFront, параметр region игнорируется.

Также можно использовать переменную среды AWS_REGION.

Дополнительную информацию см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

secret_key

псевдонимы: aws_secret_access_key, aws_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 (в порядке убывания приоритета).

Параметры secret_key и profile являются взаимоисключающими.

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для единообразия с AWS SDK botocore.

session_token

псевдонимы: aws_session_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.

Параметры session_token и profile являются взаимоисключающими.

state

строка

Создать или удалить очередь.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tags

псевдонимы: resource_tags

словарь

Словарь с тегами, которые необходимо применить к ресурсу.

Если параметр tags не задан, теги изменены не будут.

validate_certs

логический

Если задано значение false, SSL-сертификаты при обмене данными с API AWS проверяться не будут.

Настоятельно не рекомендуется устанавливать 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

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

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

Ключ

Описание

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

Идентификатор главного ключа клиента (CMK), управляемого AWS, для Amazon SQS или пользовательского CMK.

Возвращается: если значение существует

Пример: "alias/MyAlias"

maximum_message_size

integer

Максимальный размер сообщения в байтах.

Возвращается: всегда

Пример: 262144

message_retention_period

integer

Период хранения сообщений в секундах.

Возвращается: всегда

Пример: 345600

name

string

Имя очереди SQS

Возвращается: всегда

Пример: "queuename-987d2de0"

queue_arn

string

Имя ресурса Amazon (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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/sqs_queue_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API