SQS Queue
Resumo
- Cria ou deleta AWS SQS queues
- Faz update em atributos de queues existentes
Parâmetros
Parâmetro | Tipos | Escolhas | Valor Padrão | Comentário |
|---|---|---|---|
aws_access_key | string | | Chave de acesso da AWS. Se não for definido, o valor da variável de ambiente AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY ou EC2_ACCESS_KEY é usado. Se o perfil estiver definido, este parâmetro será ignorado. A transmissão das opções aws_access_key e profile ao mesmo tempo foi suspensa e as opções serão mutuamente exclusivas após 01/06/2022. |
aws_ca_bundle | path | | A localização de um CA Bundle a ser usado ao validar certificados SSL. Não usado por módulos baseados em boto 2. Observação: o CA Bundle é lido no lado do 'módulo' e pode precisar ser copiado explicitamente do controlador se não for executado localmente. |
aws_config | dictionary | | Um dicionário para modificar a configuração do botocore. Os parâmetros podem ser encontrados em https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Apenas a chave ‘user_agent’ é usada para módulos boto. Consulte http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto para obter mais configurações de boto. |
aws_secret_key | string | | Chave secreta da AWS. Se não for definido, o valor da variável de ambiente AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY ou EC2_SECRET_KEY é usado. Se o perfil estiver definido, este parâmetro será ignorado. A transmissão das opções aws_secret_key e perfil ao mesmo tempo foi suspensa e as opções serão mutuamente exclusivas após 01/06/2022. |
content_based_deduplication | boolean | Escolhas:
| Ativa a desduplicação baseada em conteúdo. Usado apenas para FIFOs. O padrão é falso. |
debug_botocore_endpoint_logs | boolean | Escolhas:
| Use um registrador botocore.endpoint para analisar as chamadas de API exclusivas (em vez do total) “resource:action” feitas durante uma tarefa, enviando o conjunto para a chave resource_actions nos resultados da tarefa. Use o retorno de chamada aws_resource_action para gerar a lista total feita durante um playbook. A variável de ambiente ANSIBLE_DEBUG_BOTOCORE_LOGS também pode ser usada. |
delay_seconds | integer | | O delay de entrega em segundos |
ec2_url | string | | URL a ser usada para conectar-se ao EC2 ou à sua nuvem Eucalyptus (por padrão, o módulo usará endpoints do EC2). Ignorado para módulos onde a região é necessária. Deve ser especificado para todos os outros módulos se a região não for usada. Se não for definido, o valor da variável de ambiente EC2_URL, se houver, será usado. |
kms_data_key_reuse_period_seconds | integer | | O tempo, em segundos, durante o qual o Amazon SQS pode reutilizar uma chave de dados para criptografar ou descriptografar mensagens antes de chamar o AWS KMS novamente. |
kms_master_key_id | string | | O ID de uma chave mestra do cliente (CMK) gerenciada pela AWS para Amazon SQS ou uma CMK personalizada. A especificação de um kms_master_key_id válido ativará a criptografia automaticamente. |
maximum_message_size | integer | | O tamanho máximo de mensagem de bytes |
message_retention_period | integer | | O periodo de retenção da mensagem em segundos |
name | string | | Nome da queue |
policy | dictionary | | A policy do dict JSON para relacionar a queue |
profile | string | | O uso de profile substituirá aws_access_key, aws_secret_key e security_token e o suporte para passá-los ao mesmo tempo em que profile foi obsoleto. aws_access_key, aws_secret_key e security_token serão mutuamente exclusivos com perfil após 01/06/2022. região aliases: aws_region, ec2_region fragmento A região da AWS a ser usada. Se não for especificado, o valor da variável de ambiente AWS_REGION ou EC2_REGION, se houver, será usado. Consulte http://docs.aws.amazon.com/general/latest/gr/rand.html#ec2_region |
purge_tags | boolean | Escolhas:
| Tags removidas não listadas em tags |
queue_type | string | Escolhas:
| Fila padrão ou FIFO. queue_type só pode ser definido na criação da fila e, caso contrário, será ignorado. |
receive_message_wait_time_seconds | integer | | O tempo de espera da mensagem recebida em segundos. |
redrive_policy | dictionary | | JSON dict com o redrive_policy (veja o exemplo). |
region | string | | região da AWS a ser usada. Se não for especificado, o valor da variável de ambiente AWS_REGION ou EC2_REGION, se houver, será usado. Consulte http://docs.aws.amazon.com/general/latest/gr/rand.html#ec2_region |
security_token | string | | Token de segurança do AWS STS. Se não for definido, o valor da variável de ambiente AWS_SECURITY_TOKEN ou EC2_SECURITY_TOKEN é usado. Se o perfil estiver definido, este parâmetro será ignorado. A passagem das opções security_token e perfil ao mesmo tempo foi suspensa e as opções serão mutuamente exclusivas após 01/06/2022. |
state | string | Escolhas:
| Cria ou deleta a queue |
tags | dictionary | | Marque dict para aplicar à fila. Para remover todas as tags, defina tags={} e purge_tags=true. |
validate_certs | boolean | Escolhas:
| Quando definido como “não”, os certificados SSL não serão validados para comunicação com as APIs da AWS. |
visibility_timeout | integer | | O timeout de visibilidade default em segundos |
Exemplos
- 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: yes
- 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: Delete SQS queue
community.aws.sqs_queue:
name: my-queue
region: ap-southeast-2
state: absent
Valores retornados
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
content_based_deduplication | boolean | sempre | Enables content-based deduplication. Used for FIFOs only. |
delay_seconds | integer | sempre | The delivery delay in seconds. |
kms_data_key_reuse_period_seconds | integer | sempre | The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. |
kms_master_key_id | string | se o valor existir | The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. |
maximum_message_size | integer | sempre | The maximum message size in bytes. |
message_retention_period | integer | sempre | The message retention period in seconds. |
name | string | sempre | Name of the SQS Queue |
queue_arn | string | sucesso | The queue’s Amazon resource name (ARN). |
queue_url | string | sucesso | URL to access the queue |
receive_message_wait_time_seconds | integer | sempre | The receive message wait time in seconds. |
region | string | sempre | Region that the queue was created within |
tags | dictionary | sempre | List of queue tags |
visibility_timeout | integer | sempre | The default visibility timeout in seconds. |