Container for the parameters to the CreateQueue operation. Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following in mind:
If you don't specify the
FifoQueueattribute, Amazon SQS creates a standard queue.You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the Amazon SQS Developer Guide.
If you don't provide a value for an attribute, the queue is created with the default value for the attribute.
If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.
After you create a queue, you must wait at least one second after the queue is created to be able to use the queue.
To get the queue URL, use the GetQueueUrl action. GetQueueUrl requires only the QueueName parameter. be aware of existing queue names:
If you provide the name of an existing queue along with the exact names and values of all the queue's attributes,
CreateQueuereturns the queue URL for the existing queue.If the queue name, attribute names, or attribute values don't match an existing queue,
CreateQueuereturns an error.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.SQS.AmazonSQSRequest
Amazon.SQS.Model.CreateQueueRequest
Namespace: Amazon.SQS.Model
Assembly: AWSSDK.SQS.dll
Version: 3.x.y.z
Syntax
public class CreateQueueRequest : AmazonSQSRequest IAmazonWebServiceRequest
The CreateQueueRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CreateQueueRequest() |
Empty constructor used to set properties independently even when a simple constructor is available |
|
|
CreateQueueRequest(string) |
Instantiates CreateQueueRequest with the parameterized properties |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Attributes | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property Attributes. A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters
that the
The following attributes apply only to dead-letter queues:
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. The following attributes apply only to server-side-encryption:
The following attributes apply only to FIFO (first-in-first-out) queues:
The following attributes apply only to high throughput for FIFO queues:
To enable high throughput for FIFO queues, do the following:
If you set these attributes to anything other than the values shown for enabling high throughput, normal throughput is in effect and deduplication occurs as specified. For information on throughput quotas, see Quotas related to messages in the Amazon SQS Developer Guide. |
|
|
QueueName | System.String |
Gets and sets the property QueueName. The name of the new queue. The following limits apply to this name:
Queue URLs and names are case-sensitive. |
|
|
Tags | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property Tags. Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide. When you use queue tags, keep the following guidelines in mind:
For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer Guide.
To be able to tag a queue on creation, you must have the Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide. |
Examples
This example shows how to create a queue.
Create queue example
var client = new AmazonSQSClient();
var attrs = new Dictionary<string, string>();
// Maximum message size of 256 KiB (1,024 bytes * 256 KiB = 262,144 bytes).
int maxMessage = 256 * 1024;
attrs.Add(QueueAttributeName.DelaySeconds,
TimeSpan.FromSeconds(5).TotalSeconds.ToString());
attrs.Add(QueueAttributeName.MaximumMessageSize, maxMessage.ToString());
attrs.Add(QueueAttributeName.MessageRetentionPeriod,
TimeSpan.FromDays(4).TotalSeconds.ToString());
attrs.Add(QueueAttributeName.ReceiveMessageWaitTimeSeconds,
TimeSpan.FromSeconds(5).TotalSeconds.ToString());
attrs.Add(QueueAttributeName.VisibilityTimeout,
TimeSpan.FromHours(12).TotalSeconds.ToString());
var request = new CreateQueueRequest
{
Attributes = attrs,
QueueName = "MyTestQueue"
};
var response = client.CreateQueue(request);
Console.WriteLine("Queue URL: " + response.QueueUrl);
The following operation creates an SQS queue named MyQueue.
Create an SQS queue
var client = new AmazonSQSClient();
var response = client.CreateQueue(new CreateQueueRequest
{
QueueName = "MyQueue", // The Name for the new queue
Attributes = new Dictionary<string, string> {
{ "foo", "bar" },
{ "ghoti", "fish" }
}
});
string queueUrl = response.QueueUrl; // The URL of the new queue
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5