Creating a new message queue

Written by

Yandex.Cloud

To create a new message queue:

Management console

AWS CLI

Terraform

Open the Message Queue section.
Click Create queue.
Enter a name for the queue.

The name may contain lowercase Latin letters, numbers, hyphens, and underscores. The name of a FIFO queue must end with the .fifo suffix. The name can't be longer than 80 characters.
Select the queue type: Standard or FIFO.
Specify the standard visibility timeout to be applied to enqueued messages after they are read by a consumer.
Specify the message retention period.
Specify the maximum message size.
Specify the delivery delay: the amount of time during which a new message cannot be picked from a queue.
Specify the message receipt timeout.
Click Create queue.

Run the following command in the terminal:

$ aws sqs create-queue --queue-name sample-queue \
            --endpoint https://message-queue.api.cloud.yandex.net/
{
    "QueueUrl": "https://message-queue.api.cloud.yandex.net/aoeaql9r10cd9cfue7v6/000000000000002n034r/sample-queue"
}

With Terraform, you can quickly create a cloud infrastructure in Yandex.Cloud. The infrastructure components are identified through configuration files that specify the required cloud resources and their parameters.

If you don't have Terraform yet, install it and configure the Yandex.Cloud provider.

To create a message queue:

In the configuration file, describe the parameters of the queue to create:

name: Queue name.
visibility_timeout_seconds: Visibility timeout.
receive_wait_time_seconds: Waiting time for messages to enter the queue if Long Polling is used. Valid values: from 0 to 20 seconds. Default: 0 seconds.
message_retention_seconds: Length of time, in seconds, to retain a message in the queue.
redrive_policy: Message redrive policy in a Dead Letter Queue.
- deadLetterTargetArn: ARN of the DLQ that messages are moved to.
- maxReceiveCount: Number of attempts to read a message from the queue before redriving it to the DLQ.
fifo_queue: Indicates that a FIFO queue is created.
content_based_deduplication: Enables content-based deduplication in FIFO queues.
access_key: ID of the service account static access key for the queue. If it isn't specified in the queue configuration, the ID from the provider configuration is used.
secret_key: Secret part of the static access key. If no secret key is set in the queue configuration, the key from the provider configuration is used.

Sample configuration file for a standard queue:

provider "yandex" {
    token = "<OAuth or static key of service account>"
    folder_id = "<folder ID>"
    zone      = "ru-central1-a"
  }

resource "yandex_message_queue" "example_queue" {
  name                        = "ymq-terraform-example"
  visibility_timeout_seconds  = 600
  receive_wait_time_seconds   = 20
  message_retention_seconds   = 1209600
  access_key                  = "<static access key ID>"
  secret_key                  = "<secret part of static access key>"
}

Sample configuration file for a FIFO queue:

provider "yandex" {
    token = "<OAuth or static key of service account>"
    folder_id = "<folder ID>"
    zone      = "ru-central1-a"
  }

resource "yandex_message_queue" "example-fifo-queue" {
  name                        = "ymq-terraform-example.fifo"
  visibility_timeout_seconds  = 600
  receive_wait_time_seconds   = 20
  message_retention_seconds   = 1209600
  fifo_queue                  = true
  access_key                  = "<static access key ID>"
  secret_key                  = "<secret part of static access key>"
}

Sample configuration file for a queue with a redrive policy for moving undelivered messages to a DLQ named ymq_terraform_deadletter_example:

provider "yandex" {
    token = "<OAuth or static key of service account>"
    folder_id = "<folder ID>"
    zone      = "ru-central1-a"
  }

resource "yandex_message_queue" "example_fifo_queue" {
  name                        = "ymq-terraform-example"
  visibility_timeout_seconds  = 600
  receive_wait_time_seconds   = 20
  message_retention_seconds   = 1209600
  redrive_policy              = jsonencode({
    deadLetterTargetArn = yandex_message_queue.example_deadletter_queue.arn
    maxReceiveCount     = 3
  })
  access_key                  = "<static access key ID>"
  secret_key                  = "<secret part of static access key>"
}

resource "yandex_message_queue" "example_deadletter_queue" {
  name                        = "ymq_terraform_deadletter_example"
  access_key                  = "<static access key ID>"
  secret_key                  = "<secret part of static access key>"
}

For more information about the resources you can create using Terraform, see the provider documentation.

Make sure that the configuration files are correct.
1. In the command line, go to the directory where you created the configuration file.
2. Run the check using the command:
```
$ terraform plan
```
If the configuration is described correctly, the terminal displays a list of created resources and their parameters. If there are errors in the configuration, Terraform points them out.
Deploy the cloud resources.
1. If the configuration doesn't contain any errors, run the command:
```
$ terraform apply
```
2. Confirm that you want to create the resources.
Afterwards, all the necessary resources are created in the specified folder. You can check resource availability and their settings in management console. To delete the created resources, run the terraform destroy command.