aws.sqs.Queue
Explore with Pulumi AI
Amazon SQS (Simple Queue Service) is a fully managed message queuing service that enables decoupling and scaling of microservices, distributed systems, and serverless applications. This resource allows you to create, configure, and manage an SQS queue, which acts as a reliable message buffer between producers and consumers. With support for standard and FIFO queues, SQS ensures secure, scalable, and asynchronous message processing. Use this resource to define queue attributes, configure access policies, and integrate seamlessly with AWS services like Lambda, SNS, and EC2.
!> AWS will hang indefinitely, leading to a timeout while waiting error, when creating or updating an aws.sqs.Queue with an associated aws.sqs.QueuePolicy if Version = "2012-10-17" is not explicitly set in the policy.
!> AWS will hang indefinitely and trigger a timeout while waiting error when creating or updating an aws.sqs.Queue if kms_data_key_reuse_period_seconds is set to a non-default value, sqs_managed_sse_enabled is false (explicitly or by default), and kms_master_key_id is not set.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const queue = new aws.sqs.Queue("queue", {
    name: "example-queue",
    delaySeconds: 90,
    maxMessageSize: 2048,
    messageRetentionSeconds: 86400,
    receiveWaitTimeSeconds: 10,
    redrivePolicy: JSON.stringify({
        deadLetterTargetArn: queueDeadletter.arn,
        maxReceiveCount: 4,
    }),
    tags: {
        Environment: "production",
    },
});
import pulumi
import json
import pulumi_aws as aws
queue = aws.sqs.Queue("queue",
    name="example-queue",
    delay_seconds=90,
    max_message_size=2048,
    message_retention_seconds=86400,
    receive_wait_time_seconds=10,
    redrive_policy=json.dumps({
        "deadLetterTargetArn": queue_deadletter["arn"],
        "maxReceiveCount": 4,
    }),
    tags={
        "Environment": "production",
    })
package main
import (
	"encoding/json"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sqs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"deadLetterTargetArn": queueDeadletter.Arn,
			"maxReceiveCount":     4,
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = sqs.NewQueue(ctx, "queue", &sqs.QueueArgs{
			Name:                    pulumi.String("example-queue"),
			DelaySeconds:            pulumi.Int(90),
			MaxMessageSize:          pulumi.Int(2048),
			MessageRetentionSeconds: pulumi.Int(86400),
			ReceiveWaitTimeSeconds:  pulumi.Int(10),
			RedrivePolicy:           pulumi.String(json0),
			Tags: pulumi.StringMap{
				"Environment": pulumi.String("production"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() => 
{
    var queue = new Aws.Sqs.Queue("queue", new()
    {
        Name = "example-queue",
        DelaySeconds = 90,
        MaxMessageSize = 2048,
        MessageRetentionSeconds = 86400,
        ReceiveWaitTimeSeconds = 10,
        RedrivePolicy = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["deadLetterTargetArn"] = queueDeadletter.Arn,
            ["maxReceiveCount"] = 4,
        }),
        Tags = 
        {
            { "Environment", "production" },
        },
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sqs.Queue;
import com.pulumi.aws.sqs.QueueArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var queue = new Queue("queue", QueueArgs.builder()
            .name("example-queue")
            .delaySeconds(90)
            .maxMessageSize(2048)
            .messageRetentionSeconds(86400)
            .receiveWaitTimeSeconds(10)
            .redrivePolicy(serializeJson(
                jsonObject(
                    jsonProperty("deadLetterTargetArn", queueDeadletter.arn()),
                    jsonProperty("maxReceiveCount", 4)
                )))
            .tags(Map.of("Environment", "production"))
            .build());
    }
}
resources:
  queue:
    type: aws:sqs:Queue
    properties:
      name: example-queue
      delaySeconds: 90
      maxMessageSize: 2048
      messageRetentionSeconds: 86400
      receiveWaitTimeSeconds: 10
      redrivePolicy:
        fn::toJSON:
          deadLetterTargetArn: ${queueDeadletter.arn}
          maxReceiveCount: 4
      tags:
        Environment: production
FIFO queue
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const queue = new aws.sqs.Queue("queue", {
    name: "example-queue.fifo",
    fifoQueue: true,
    contentBasedDeduplication: true,
});
import pulumi
import pulumi_aws as aws
queue = aws.sqs.Queue("queue",
    name="example-queue.fifo",
    fifo_queue=True,
    content_based_deduplication=True)
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sqs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sqs.NewQueue(ctx, "queue", &sqs.QueueArgs{
			Name:                      pulumi.String("example-queue.fifo"),
			FifoQueue:                 pulumi.Bool(true),
			ContentBasedDeduplication: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() => 
{
    var queue = new Aws.Sqs.Queue("queue", new()
    {
        Name = "example-queue.fifo",
        FifoQueue = true,
        ContentBasedDeduplication = true,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sqs.Queue;
import com.pulumi.aws.sqs.QueueArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var queue = new Queue("queue", QueueArgs.builder()
            .name("example-queue.fifo")
            .fifoQueue(true)
            .contentBasedDeduplication(true)
            .build());
    }
}
resources:
  queue:
    type: aws:sqs:Queue
    properties:
      name: example-queue.fifo
      fifoQueue: true
      contentBasedDeduplication: true
High-throughput FIFO queue
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const queue = new aws.sqs.Queue("queue", {
    name: "pulumi-example-queue.fifo",
    fifoQueue: true,
    deduplicationScope: "messageGroup",
    fifoThroughputLimit: "perMessageGroupId",
});
import pulumi
import pulumi_aws as aws
queue = aws.sqs.Queue("queue",
    name="pulumi-example-queue.fifo",
    fifo_queue=True,
    deduplication_scope="messageGroup",
    fifo_throughput_limit="perMessageGroupId")
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sqs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sqs.NewQueue(ctx, "queue", &sqs.QueueArgs{
			Name:                pulumi.String("pulumi-example-queue.fifo"),
			FifoQueue:           pulumi.Bool(true),
			DeduplicationScope:  pulumi.String("messageGroup"),
			FifoThroughputLimit: pulumi.String("perMessageGroupId"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() => 
{
    var queue = new Aws.Sqs.Queue("queue", new()
    {
        Name = "pulumi-example-queue.fifo",
        FifoQueue = true,
        DeduplicationScope = "messageGroup",
        FifoThroughputLimit = "perMessageGroupId",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sqs.Queue;
import com.pulumi.aws.sqs.QueueArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var queue = new Queue("queue", QueueArgs.builder()
            .name("pulumi-example-queue.fifo")
            .fifoQueue(true)
            .deduplicationScope("messageGroup")
            .fifoThroughputLimit("perMessageGroupId")
            .build());
    }
}
resources:
  queue:
    type: aws:sqs:Queue
    properties:
      name: pulumi-example-queue.fifo
      fifoQueue: true
      deduplicationScope: messageGroup
      fifoThroughputLimit: perMessageGroupId
Dead-letter queue
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const queue = new aws.sqs.Queue("queue", {
    name: "pulumi-example-queue",
    redrivePolicy: JSON.stringify({
        deadLetterTargetArn: queueDeadletter.arn,
        maxReceiveCount: 4,
    }),
});
const exampleQueueDeadletter = new aws.sqs.Queue("example_queue_deadletter", {name: "pulumi-example-deadletter-queue"});
const exampleQueueRedriveAllowPolicy = new aws.sqs.RedriveAllowPolicy("example_queue_redrive_allow_policy", {
    queueUrl: exampleQueueDeadletter.id,
    redriveAllowPolicy: JSON.stringify({
        redrivePermission: "byQueue",
        sourceQueueArns: [exampleQueue.arn],
    }),
});
import pulumi
import json
import pulumi_aws as aws
queue = aws.sqs.Queue("queue",
    name="pulumi-example-queue",
    redrive_policy=json.dumps({
        "deadLetterTargetArn": queue_deadletter["arn"],
        "maxReceiveCount": 4,
    }))
example_queue_deadletter = aws.sqs.Queue("example_queue_deadletter", name="pulumi-example-deadletter-queue")
example_queue_redrive_allow_policy = aws.sqs.RedriveAllowPolicy("example_queue_redrive_allow_policy",
    queue_url=example_queue_deadletter.id,
    redrive_allow_policy=json.dumps({
        "redrivePermission": "byQueue",
        "sourceQueueArns": [example_queue["arn"]],
    }))
package main
import (
	"encoding/json"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sqs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"deadLetterTargetArn": queueDeadletter.Arn,
			"maxReceiveCount":     4,
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = sqs.NewQueue(ctx, "queue", &sqs.QueueArgs{
			Name:          pulumi.String("pulumi-example-queue"),
			RedrivePolicy: pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		exampleQueueDeadletter, err := sqs.NewQueue(ctx, "example_queue_deadletter", &sqs.QueueArgs{
			Name: pulumi.String("pulumi-example-deadletter-queue"),
		})
		if err != nil {
			return err
		}
		tmpJSON1, err := json.Marshal(map[string]interface{}{
			"redrivePermission": "byQueue",
			"sourceQueueArns": []interface{}{
				exampleQueue.Arn,
			},
		})
		if err != nil {
			return err
		}
		json1 := string(tmpJSON1)
		_, err = sqs.NewRedriveAllowPolicy(ctx, "example_queue_redrive_allow_policy", &sqs.RedriveAllowPolicyArgs{
			QueueUrl:           exampleQueueDeadletter.ID(),
			RedriveAllowPolicy: pulumi.String(json1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() => 
{
    var queue = new Aws.Sqs.Queue("queue", new()
    {
        Name = "pulumi-example-queue",
        RedrivePolicy = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["deadLetterTargetArn"] = queueDeadletter.Arn,
            ["maxReceiveCount"] = 4,
        }),
    });
    var exampleQueueDeadletter = new Aws.Sqs.Queue("example_queue_deadletter", new()
    {
        Name = "pulumi-example-deadletter-queue",
    });
    var exampleQueueRedriveAllowPolicy = new Aws.Sqs.RedriveAllowPolicy("example_queue_redrive_allow_policy", new()
    {
        QueueUrl = exampleQueueDeadletter.Id,
        RedriveAllowPolicyName = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["redrivePermission"] = "byQueue",
            ["sourceQueueArns"] = new[]
            {
                exampleQueue.Arn,
            },
        }),
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sqs.Queue;
import com.pulumi.aws.sqs.QueueArgs;
import com.pulumi.aws.sqs.RedriveAllowPolicy;
import com.pulumi.aws.sqs.RedriveAllowPolicyArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var queue = new Queue("queue", QueueArgs.builder()
            .name("pulumi-example-queue")
            .redrivePolicy(serializeJson(
                jsonObject(
                    jsonProperty("deadLetterTargetArn", queueDeadletter.arn()),
                    jsonProperty("maxReceiveCount", 4)
                )))
            .build());
        var exampleQueueDeadletter = new Queue("exampleQueueDeadletter", QueueArgs.builder()
            .name("pulumi-example-deadletter-queue")
            .build());
        var exampleQueueRedriveAllowPolicy = new RedriveAllowPolicy("exampleQueueRedriveAllowPolicy", RedriveAllowPolicyArgs.builder()
            .queueUrl(exampleQueueDeadletter.id())
            .redriveAllowPolicy(serializeJson(
                jsonObject(
                    jsonProperty("redrivePermission", "byQueue"),
                    jsonProperty("sourceQueueArns", jsonArray(exampleQueue.arn()))
                )))
            .build());
    }
}
resources:
  queue:
    type: aws:sqs:Queue
    properties:
      name: pulumi-example-queue
      redrivePolicy:
        fn::toJSON:
          deadLetterTargetArn: ${queueDeadletter.arn}
          maxReceiveCount: 4
  exampleQueueDeadletter:
    type: aws:sqs:Queue
    name: example_queue_deadletter
    properties:
      name: pulumi-example-deadletter-queue
  exampleQueueRedriveAllowPolicy:
    type: aws:sqs:RedriveAllowPolicy
    name: example_queue_redrive_allow_policy
    properties:
      queueUrl: ${exampleQueueDeadletter.id}
      redriveAllowPolicy:
        fn::toJSON:
          redrivePermission: byQueue
          sourceQueueArns:
            - ${exampleQueue.arn}
Server-side encryption (SSE)
Using SSE-SQS:
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const queue = new aws.sqs.Queue("queue", {
    name: "pulumi-example-queue",
    sqsManagedSseEnabled: true,
});
import pulumi
import pulumi_aws as aws
queue = aws.sqs.Queue("queue",
    name="pulumi-example-queue",
    sqs_managed_sse_enabled=True)
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sqs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sqs.NewQueue(ctx, "queue", &sqs.QueueArgs{
			Name:                 pulumi.String("pulumi-example-queue"),
			SqsManagedSseEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() => 
{
    var queue = new Aws.Sqs.Queue("queue", new()
    {
        Name = "pulumi-example-queue",
        SqsManagedSseEnabled = true,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sqs.Queue;
import com.pulumi.aws.sqs.QueueArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var queue = new Queue("queue", QueueArgs.builder()
            .name("pulumi-example-queue")
            .sqsManagedSseEnabled(true)
            .build());
    }
}
resources:
  queue:
    type: aws:sqs:Queue
    properties:
      name: pulumi-example-queue
      sqsManagedSseEnabled: true
Using SSE-KMS:
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const queue = new aws.sqs.Queue("queue", {
    name: "example-queue",
    kmsMasterKeyId: "alias/aws/sqs",
    kmsDataKeyReusePeriodSeconds: 300,
});
import pulumi
import pulumi_aws as aws
queue = aws.sqs.Queue("queue",
    name="example-queue",
    kms_master_key_id="alias/aws/sqs",
    kms_data_key_reuse_period_seconds=300)
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sqs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sqs.NewQueue(ctx, "queue", &sqs.QueueArgs{
			Name:                         pulumi.String("example-queue"),
			KmsMasterKeyId:               pulumi.String("alias/aws/sqs"),
			KmsDataKeyReusePeriodSeconds: pulumi.Int(300),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() => 
{
    var queue = new Aws.Sqs.Queue("queue", new()
    {
        Name = "example-queue",
        KmsMasterKeyId = "alias/aws/sqs",
        KmsDataKeyReusePeriodSeconds = 300,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sqs.Queue;
import com.pulumi.aws.sqs.QueueArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var queue = new Queue("queue", QueueArgs.builder()
            .name("example-queue")
            .kmsMasterKeyId("alias/aws/sqs")
            .kmsDataKeyReusePeriodSeconds(300)
            .build());
    }
}
resources:
  queue:
    type: aws:sqs:Queue
    properties:
      name: example-queue
      kmsMasterKeyId: alias/aws/sqs
      kmsDataKeyReusePeriodSeconds: 300
Create Queue Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Queue(name: string, args?: QueueArgs, opts?: CustomResourceOptions);@overload
def Queue(resource_name: str,
          args: Optional[QueueArgs] = None,
          opts: Optional[ResourceOptions] = None)
@overload
def Queue(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          content_based_deduplication: Optional[bool] = None,
          deduplication_scope: Optional[str] = None,
          delay_seconds: Optional[int] = None,
          fifo_queue: Optional[bool] = None,
          fifo_throughput_limit: Optional[str] = None,
          kms_data_key_reuse_period_seconds: Optional[int] = None,
          kms_master_key_id: Optional[str] = None,
          max_message_size: Optional[int] = None,
          message_retention_seconds: Optional[int] = None,
          name: Optional[str] = None,
          name_prefix: Optional[str] = None,
          policy: Optional[str] = None,
          receive_wait_time_seconds: Optional[int] = None,
          redrive_allow_policy: Optional[str] = None,
          redrive_policy: Optional[str] = None,
          sqs_managed_sse_enabled: Optional[bool] = None,
          tags: Optional[Mapping[str, str]] = None,
          visibility_timeout_seconds: Optional[int] = None)func NewQueue(ctx *Context, name string, args *QueueArgs, opts ...ResourceOption) (*Queue, error)public Queue(string name, QueueArgs? args = null, CustomResourceOptions? opts = null)type: aws:sqs:Queue
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args QueueArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args QueueArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args QueueArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args QueueArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args QueueArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var examplequeueResourceResourceFromSqsqueue = new Aws.Sqs.Queue("examplequeueResourceResourceFromSqsqueue", new()
{
    ContentBasedDeduplication = false,
    DeduplicationScope = "string",
    DelaySeconds = 0,
    FifoQueue = false,
    FifoThroughputLimit = "string",
    KmsDataKeyReusePeriodSeconds = 0,
    KmsMasterKeyId = "string",
    MaxMessageSize = 0,
    MessageRetentionSeconds = 0,
    Name = "string",
    NamePrefix = "string",
    Policy = "string",
    ReceiveWaitTimeSeconds = 0,
    RedriveAllowPolicy = "string",
    RedrivePolicy = "string",
    SqsManagedSseEnabled = false,
    Tags = 
    {
        { "string", "string" },
    },
    VisibilityTimeoutSeconds = 0,
});
example, err := sqs.NewQueue(ctx, "examplequeueResourceResourceFromSqsqueue", &sqs.QueueArgs{
	ContentBasedDeduplication:    pulumi.Bool(false),
	DeduplicationScope:           pulumi.String("string"),
	DelaySeconds:                 pulumi.Int(0),
	FifoQueue:                    pulumi.Bool(false),
	FifoThroughputLimit:          pulumi.String("string"),
	KmsDataKeyReusePeriodSeconds: pulumi.Int(0),
	KmsMasterKeyId:               pulumi.String("string"),
	MaxMessageSize:               pulumi.Int(0),
	MessageRetentionSeconds:      pulumi.Int(0),
	Name:                         pulumi.String("string"),
	NamePrefix:                   pulumi.String("string"),
	Policy:                       pulumi.String("string"),
	ReceiveWaitTimeSeconds:       pulumi.Int(0),
	RedriveAllowPolicy:           pulumi.String("string"),
	RedrivePolicy:                pulumi.String("string"),
	SqsManagedSseEnabled:         pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VisibilityTimeoutSeconds: pulumi.Int(0),
})
var examplequeueResourceResourceFromSqsqueue = new Queue("examplequeueResourceResourceFromSqsqueue", QueueArgs.builder()
    .contentBasedDeduplication(false)
    .deduplicationScope("string")
    .delaySeconds(0)
    .fifoQueue(false)
    .fifoThroughputLimit("string")
    .kmsDataKeyReusePeriodSeconds(0)
    .kmsMasterKeyId("string")
    .maxMessageSize(0)
    .messageRetentionSeconds(0)
    .name("string")
    .namePrefix("string")
    .policy("string")
    .receiveWaitTimeSeconds(0)
    .redriveAllowPolicy("string")
    .redrivePolicy("string")
    .sqsManagedSseEnabled(false)
    .tags(Map.of("string", "string"))
    .visibilityTimeoutSeconds(0)
    .build());
examplequeue_resource_resource_from_sqsqueue = aws.sqs.Queue("examplequeueResourceResourceFromSqsqueue",
    content_based_deduplication=False,
    deduplication_scope="string",
    delay_seconds=0,
    fifo_queue=False,
    fifo_throughput_limit="string",
    kms_data_key_reuse_period_seconds=0,
    kms_master_key_id="string",
    max_message_size=0,
    message_retention_seconds=0,
    name="string",
    name_prefix="string",
    policy="string",
    receive_wait_time_seconds=0,
    redrive_allow_policy="string",
    redrive_policy="string",
    sqs_managed_sse_enabled=False,
    tags={
        "string": "string",
    },
    visibility_timeout_seconds=0)
const examplequeueResourceResourceFromSqsqueue = new aws.sqs.Queue("examplequeueResourceResourceFromSqsqueue", {
    contentBasedDeduplication: false,
    deduplicationScope: "string",
    delaySeconds: 0,
    fifoQueue: false,
    fifoThroughputLimit: "string",
    kmsDataKeyReusePeriodSeconds: 0,
    kmsMasterKeyId: "string",
    maxMessageSize: 0,
    messageRetentionSeconds: 0,
    name: "string",
    namePrefix: "string",
    policy: "string",
    receiveWaitTimeSeconds: 0,
    redriveAllowPolicy: "string",
    redrivePolicy: "string",
    sqsManagedSseEnabled: false,
    tags: {
        string: "string",
    },
    visibilityTimeoutSeconds: 0,
});
type: aws:sqs:Queue
properties:
    contentBasedDeduplication: false
    deduplicationScope: string
    delaySeconds: 0
    fifoQueue: false
    fifoThroughputLimit: string
    kmsDataKeyReusePeriodSeconds: 0
    kmsMasterKeyId: string
    maxMessageSize: 0
    messageRetentionSeconds: 0
    name: string
    namePrefix: string
    policy: string
    receiveWaitTimeSeconds: 0
    redriveAllowPolicy: string
    redrivePolicy: string
    sqsManagedSseEnabled: false
    tags:
        string: string
    visibilityTimeoutSeconds: 0
Queue Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Queue resource accepts the following input properties:
- ContentBased boolDeduplication 
- Enables content-based deduplication for FIFO queues. For more information, see the related documentation.
- DeduplicationScope string
- Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroupandqueue(default).
- DelaySeconds int
- Time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 seconds.
- FifoQueue bool
- Boolean designating a FIFO queue. If not set, it defaults to falsemaking it standard.
- FifoThroughput stringLimit 
- Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue(default) andperMessageGroupId.
- KmsData intKey Reuse Period Seconds 
- Length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
- KmsMaster stringKey Id 
- ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
- MaxMessage intSize 
- Limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).
- MessageRetention intSeconds 
- Number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).
- Name string
- Name of the queue. Queue names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 80 characters long. For a FIFO (first-in-first-out) queue, the name must end with the .fifosuffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix.
- NamePrefix string
- Creates a unique name beginning with the specified prefix. Conflicts with name.
- Policy string
- JSON policy for the SQS queue. For more information about building AWS IAM policy documents with Pulumi, see the AWS IAM Policy Document Guide.
- ReceiveWait intTime Seconds 
- Time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default for this attribute is 0, meaning that the call will return immediately.
- RedriveAllow stringPolicy 
- JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- RedrivePolicy string
- JSON policy to set up the Dead Letter Queue, see AWS docs. Note: when specifying maxReceiveCount, you must specify it as an integer (5), and not a string ("5").
- SqsManaged boolSse Enabled 
- Boolean to enable server-side encryption (SSE) of message content with SQS-owned encryption keys. See Encryption at rest. The provider will only perform drift detection of its value when present in a configuration.
- Dictionary<string, string>
- Map of tags to assign to the queue. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- VisibilityTimeout intSeconds 
- Visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see AWS docs.
- ContentBased boolDeduplication 
- Enables content-based deduplication for FIFO queues. For more information, see the related documentation.
- DeduplicationScope string
- Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroupandqueue(default).
- DelaySeconds int
- Time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 seconds.
- FifoQueue bool
- Boolean designating a FIFO queue. If not set, it defaults to falsemaking it standard.
- FifoThroughput stringLimit 
- Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue(default) andperMessageGroupId.
- KmsData intKey Reuse Period Seconds 
- Length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
- KmsMaster stringKey Id 
- ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
- MaxMessage intSize 
- Limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).
- MessageRetention intSeconds 
- Number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).
- Name string
- Name of the queue. Queue names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 80 characters long. For a FIFO (first-in-first-out) queue, the name must end with the .fifosuffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix.
- NamePrefix string
- Creates a unique name beginning with the specified prefix. Conflicts with name.
- Policy string
- JSON policy for the SQS queue. For more information about building AWS IAM policy documents with Pulumi, see the AWS IAM Policy Document Guide.
- ReceiveWait intTime Seconds 
- Time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default for this attribute is 0, meaning that the call will return immediately.
- RedriveAllow stringPolicy 
- JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- RedrivePolicy string
- JSON policy to set up the Dead Letter Queue, see AWS docs. Note: when specifying maxReceiveCount, you must specify it as an integer (5), and not a string ("5").
- SqsManaged boolSse Enabled 
- Boolean to enable server-side encryption (SSE) of message content with SQS-owned encryption keys. See Encryption at rest. The provider will only perform drift detection of its value when present in a configuration.
- map[string]string
- Map of tags to assign to the queue. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- VisibilityTimeout intSeconds 
- Visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see AWS docs.
- contentBased BooleanDeduplication 
- Enables content-based deduplication for FIFO queues. For more information, see the related documentation.
- deduplicationScope String
- Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroupandqueue(default).
- delaySeconds Integer
- Time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 seconds.
- fifoQueue Boolean
- Boolean designating a FIFO queue. If not set, it defaults to falsemaking it standard.
- fifoThroughput StringLimit 
- Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue(default) andperMessageGroupId.
- kmsData IntegerKey Reuse Period Seconds 
- Length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
- kmsMaster StringKey Id 
- ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
- maxMessage IntegerSize 
- Limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).
- messageRetention IntegerSeconds 
- Number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).
- name String
- Name of the queue. Queue names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 80 characters long. For a FIFO (first-in-first-out) queue, the name must end with the .fifosuffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix.
- namePrefix String
- Creates a unique name beginning with the specified prefix. Conflicts with name.
- policy String
- JSON policy for the SQS queue. For more information about building AWS IAM policy documents with Pulumi, see the AWS IAM Policy Document Guide.
- receiveWait IntegerTime Seconds 
- Time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default for this attribute is 0, meaning that the call will return immediately.
- redriveAllow StringPolicy 
- JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- redrivePolicy String
- JSON policy to set up the Dead Letter Queue, see AWS docs. Note: when specifying maxReceiveCount, you must specify it as an integer (5), and not a string ("5").
- sqsManaged BooleanSse Enabled 
- Boolean to enable server-side encryption (SSE) of message content with SQS-owned encryption keys. See Encryption at rest. The provider will only perform drift detection of its value when present in a configuration.
- Map<String,String>
- Map of tags to assign to the queue. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- visibilityTimeout IntegerSeconds 
- Visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see AWS docs.
- contentBased booleanDeduplication 
- Enables content-based deduplication for FIFO queues. For more information, see the related documentation.
- deduplicationScope string
- Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroupandqueue(default).
- delaySeconds number
- Time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 seconds.
- fifoQueue boolean
- Boolean designating a FIFO queue. If not set, it defaults to falsemaking it standard.
- fifoThroughput stringLimit 
- Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue(default) andperMessageGroupId.
- kmsData numberKey Reuse Period Seconds 
- Length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
- kmsMaster stringKey Id 
- ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
- maxMessage numberSize 
- Limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).
- messageRetention numberSeconds 
- Number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).
- name string
- Name of the queue. Queue names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 80 characters long. For a FIFO (first-in-first-out) queue, the name must end with the .fifosuffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix.
- namePrefix string
- Creates a unique name beginning with the specified prefix. Conflicts with name.
- policy string
- JSON policy for the SQS queue. For more information about building AWS IAM policy documents with Pulumi, see the AWS IAM Policy Document Guide.
- receiveWait numberTime Seconds 
- Time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default for this attribute is 0, meaning that the call will return immediately.
- redriveAllow stringPolicy 
- JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- redrivePolicy string
- JSON policy to set up the Dead Letter Queue, see AWS docs. Note: when specifying maxReceiveCount, you must specify it as an integer (5), and not a string ("5").
- sqsManaged booleanSse Enabled 
- Boolean to enable server-side encryption (SSE) of message content with SQS-owned encryption keys. See Encryption at rest. The provider will only perform drift detection of its value when present in a configuration.
- {[key: string]: string}
- Map of tags to assign to the queue. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- visibilityTimeout numberSeconds 
- Visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see AWS docs.
- content_based_ booldeduplication 
- Enables content-based deduplication for FIFO queues. For more information, see the related documentation.
- deduplication_scope str
- Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroupandqueue(default).
- delay_seconds int
- Time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 seconds.
- fifo_queue bool
- Boolean designating a FIFO queue. If not set, it defaults to falsemaking it standard.
- fifo_throughput_ strlimit 
- Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue(default) andperMessageGroupId.
- kms_data_ intkey_ reuse_ period_ seconds 
- Length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
- kms_master_ strkey_ id 
- ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
- max_message_ intsize 
- Limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).
- message_retention_ intseconds 
- Number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).
- name str
- Name of the queue. Queue names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 80 characters long. For a FIFO (first-in-first-out) queue, the name must end with the .fifosuffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix.
- name_prefix str
- Creates a unique name beginning with the specified prefix. Conflicts with name.
- policy str
- JSON policy for the SQS queue. For more information about building AWS IAM policy documents with Pulumi, see the AWS IAM Policy Document Guide.
- receive_wait_ inttime_ seconds 
- Time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default for this attribute is 0, meaning that the call will return immediately.
- redrive_allow_ strpolicy 
- JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- redrive_policy str
- JSON policy to set up the Dead Letter Queue, see AWS docs. Note: when specifying maxReceiveCount, you must specify it as an integer (5), and not a string ("5").
- sqs_managed_ boolsse_ enabled 
- Boolean to enable server-side encryption (SSE) of message content with SQS-owned encryption keys. See Encryption at rest. The provider will only perform drift detection of its value when present in a configuration.
- Mapping[str, str]
- Map of tags to assign to the queue. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- visibility_timeout_ intseconds 
- Visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see AWS docs.
- contentBased BooleanDeduplication 
- Enables content-based deduplication for FIFO queues. For more information, see the related documentation.
- deduplicationScope String
- Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroupandqueue(default).
- delaySeconds Number
- Time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 seconds.
- fifoQueue Boolean
- Boolean designating a FIFO queue. If not set, it defaults to falsemaking it standard.
- fifoThroughput StringLimit 
- Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue(default) andperMessageGroupId.
- kmsData NumberKey Reuse Period Seconds 
- Length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
- kmsMaster StringKey Id 
- ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
- maxMessage NumberSize 
- Limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).
- messageRetention NumberSeconds 
- Number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).
- name String
- Name of the queue. Queue names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 80 characters long. For a FIFO (first-in-first-out) queue, the name must end with the .fifosuffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix.
- namePrefix String
- Creates a unique name beginning with the specified prefix. Conflicts with name.
- policy String
- JSON policy for the SQS queue. For more information about building AWS IAM policy documents with Pulumi, see the AWS IAM Policy Document Guide.
- receiveWait NumberTime Seconds 
- Time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default for this attribute is 0, meaning that the call will return immediately.
- redriveAllow StringPolicy 
- JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- redrivePolicy String
- JSON policy to set up the Dead Letter Queue, see AWS docs. Note: when specifying maxReceiveCount, you must specify it as an integer (5), and not a string ("5").
- sqsManaged BooleanSse Enabled 
- Boolean to enable server-side encryption (SSE) of message content with SQS-owned encryption keys. See Encryption at rest. The provider will only perform drift detection of its value when present in a configuration.
- Map<String>
- Map of tags to assign to the queue. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- visibilityTimeout NumberSeconds 
- Visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see AWS docs.
Outputs
All input properties are implicitly available as output properties. Additionally, the Queue resource produces the following output properties:
- Arn string
- ARN of the SQS queue.
- Id string
- The provider-assigned unique ID for this managed resource.
- Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- Url string
- Same as id: The URL for the created Amazon SQS queue.
- arn string
- ARN of the SQS queue.
- id string
- The provider-assigned unique ID for this managed resource.
- {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- url string
- Same as id: The URL for the created Amazon SQS queue.
Look up Existing Queue Resource
Get an existing Queue resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: QueueState, opts?: CustomResourceOptions): Queue@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        content_based_deduplication: Optional[bool] = None,
        deduplication_scope: Optional[str] = None,
        delay_seconds: Optional[int] = None,
        fifo_queue: Optional[bool] = None,
        fifo_throughput_limit: Optional[str] = None,
        kms_data_key_reuse_period_seconds: Optional[int] = None,
        kms_master_key_id: Optional[str] = None,
        max_message_size: Optional[int] = None,
        message_retention_seconds: Optional[int] = None,
        name: Optional[str] = None,
        name_prefix: Optional[str] = None,
        policy: Optional[str] = None,
        receive_wait_time_seconds: Optional[int] = None,
        redrive_allow_policy: Optional[str] = None,
        redrive_policy: Optional[str] = None,
        sqs_managed_sse_enabled: Optional[bool] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        url: Optional[str] = None,
        visibility_timeout_seconds: Optional[int] = None) -> Queuefunc GetQueue(ctx *Context, name string, id IDInput, state *QueueState, opts ...ResourceOption) (*Queue, error)public static Queue Get(string name, Input<string> id, QueueState? state, CustomResourceOptions? opts = null)public static Queue get(String name, Output<String> id, QueueState state, CustomResourceOptions options)resources:  _:    type: aws:sqs:Queue    get:      id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- ARN of the SQS queue.
- ContentBased boolDeduplication 
- Enables content-based deduplication for FIFO queues. For more information, see the related documentation.
- DeduplicationScope string
- Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroupandqueue(default).
- DelaySeconds int
- Time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 seconds.
- FifoQueue bool
- Boolean designating a FIFO queue. If not set, it defaults to falsemaking it standard.
- FifoThroughput stringLimit 
- Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue(default) andperMessageGroupId.
- KmsData intKey Reuse Period Seconds 
- Length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
- KmsMaster stringKey Id 
- ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
- MaxMessage intSize 
- Limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).
- MessageRetention intSeconds 
- Number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).
- Name string
- Name of the queue. Queue names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 80 characters long. For a FIFO (first-in-first-out) queue, the name must end with the .fifosuffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix.
- NamePrefix string
- Creates a unique name beginning with the specified prefix. Conflicts with name.
- Policy string
- JSON policy for the SQS queue. For more information about building AWS IAM policy documents with Pulumi, see the AWS IAM Policy Document Guide.
- ReceiveWait intTime Seconds 
- Time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default for this attribute is 0, meaning that the call will return immediately.
- RedriveAllow stringPolicy 
- JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- RedrivePolicy string
- JSON policy to set up the Dead Letter Queue, see AWS docs. Note: when specifying maxReceiveCount, you must specify it as an integer (5), and not a string ("5").
- SqsManaged boolSse Enabled 
- Boolean to enable server-side encryption (SSE) of message content with SQS-owned encryption keys. See Encryption at rest. The provider will only perform drift detection of its value when present in a configuration.
- Dictionary<string, string>
- Map of tags to assign to the queue. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- Url string
- Same as id: The URL for the created Amazon SQS queue.
- VisibilityTimeout intSeconds 
- Visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see AWS docs.
- Arn string
- ARN of the SQS queue.
- ContentBased boolDeduplication 
- Enables content-based deduplication for FIFO queues. For more information, see the related documentation.
- DeduplicationScope string
- Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroupandqueue(default).
- DelaySeconds int
- Time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 seconds.
- FifoQueue bool
- Boolean designating a FIFO queue. If not set, it defaults to falsemaking it standard.
- FifoThroughput stringLimit 
- Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue(default) andperMessageGroupId.
- KmsData intKey Reuse Period Seconds 
- Length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
- KmsMaster stringKey Id 
- ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
- MaxMessage intSize 
- Limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).
- MessageRetention intSeconds 
- Number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).
- Name string
- Name of the queue. Queue names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 80 characters long. For a FIFO (first-in-first-out) queue, the name must end with the .fifosuffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix.
- NamePrefix string
- Creates a unique name beginning with the specified prefix. Conflicts with name.
- Policy string
- JSON policy for the SQS queue. For more information about building AWS IAM policy documents with Pulumi, see the AWS IAM Policy Document Guide.
- ReceiveWait intTime Seconds 
- Time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default for this attribute is 0, meaning that the call will return immediately.
- RedriveAllow stringPolicy 
- JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- RedrivePolicy string
- JSON policy to set up the Dead Letter Queue, see AWS docs. Note: when specifying maxReceiveCount, you must specify it as an integer (5), and not a string ("5").
- SqsManaged boolSse Enabled 
- Boolean to enable server-side encryption (SSE) of message content with SQS-owned encryption keys. See Encryption at rest. The provider will only perform drift detection of its value when present in a configuration.
- map[string]string
- Map of tags to assign to the queue. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- map[string]string
- Map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- Url string
- Same as id: The URL for the created Amazon SQS queue.
- VisibilityTimeout intSeconds 
- Visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see AWS docs.
- arn String
- ARN of the SQS queue.
- contentBased BooleanDeduplication 
- Enables content-based deduplication for FIFO queues. For more information, see the related documentation.
- deduplicationScope String
- Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroupandqueue(default).
- delaySeconds Integer
- Time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 seconds.
- fifoQueue Boolean
- Boolean designating a FIFO queue. If not set, it defaults to falsemaking it standard.
- fifoThroughput StringLimit 
- Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue(default) andperMessageGroupId.
- kmsData IntegerKey Reuse Period Seconds 
- Length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
- kmsMaster StringKey Id 
- ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
- maxMessage IntegerSize 
- Limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).
- messageRetention IntegerSeconds 
- Number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).
- name String
- Name of the queue. Queue names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 80 characters long. For a FIFO (first-in-first-out) queue, the name must end with the .fifosuffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix.
- namePrefix String
- Creates a unique name beginning with the specified prefix. Conflicts with name.
- policy String
- JSON policy for the SQS queue. For more information about building AWS IAM policy documents with Pulumi, see the AWS IAM Policy Document Guide.
- receiveWait IntegerTime Seconds 
- Time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default for this attribute is 0, meaning that the call will return immediately.
- redriveAllow StringPolicy 
- JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- redrivePolicy String
- JSON policy to set up the Dead Letter Queue, see AWS docs. Note: when specifying maxReceiveCount, you must specify it as an integer (5), and not a string ("5").
- sqsManaged BooleanSse Enabled 
- Boolean to enable server-side encryption (SSE) of message content with SQS-owned encryption keys. See Encryption at rest. The provider will only perform drift detection of its value when present in a configuration.
- Map<String,String>
- Map of tags to assign to the queue. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- url String
- Same as id: The URL for the created Amazon SQS queue.
- visibilityTimeout IntegerSeconds 
- Visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see AWS docs.
- arn string
- ARN of the SQS queue.
- contentBased booleanDeduplication 
- Enables content-based deduplication for FIFO queues. For more information, see the related documentation.
- deduplicationScope string
- Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroupandqueue(default).
- delaySeconds number
- Time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 seconds.
- fifoQueue boolean
- Boolean designating a FIFO queue. If not set, it defaults to falsemaking it standard.
- fifoThroughput stringLimit 
- Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue(default) andperMessageGroupId.
- kmsData numberKey Reuse Period Seconds 
- Length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
- kmsMaster stringKey Id 
- ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
- maxMessage numberSize 
- Limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).
- messageRetention numberSeconds 
- Number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).
- name string
- Name of the queue. Queue names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 80 characters long. For a FIFO (first-in-first-out) queue, the name must end with the .fifosuffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix.
- namePrefix string
- Creates a unique name beginning with the specified prefix. Conflicts with name.
- policy string
- JSON policy for the SQS queue. For more information about building AWS IAM policy documents with Pulumi, see the AWS IAM Policy Document Guide.
- receiveWait numberTime Seconds 
- Time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default for this attribute is 0, meaning that the call will return immediately.
- redriveAllow stringPolicy 
- JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- redrivePolicy string
- JSON policy to set up the Dead Letter Queue, see AWS docs. Note: when specifying maxReceiveCount, you must specify it as an integer (5), and not a string ("5").
- sqsManaged booleanSse Enabled 
- Boolean to enable server-side encryption (SSE) of message content with SQS-owned encryption keys. See Encryption at rest. The provider will only perform drift detection of its value when present in a configuration.
- {[key: string]: string}
- Map of tags to assign to the queue. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- url string
- Same as id: The URL for the created Amazon SQS queue.
- visibilityTimeout numberSeconds 
- Visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see AWS docs.
- arn str
- ARN of the SQS queue.
- content_based_ booldeduplication 
- Enables content-based deduplication for FIFO queues. For more information, see the related documentation.
- deduplication_scope str
- Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroupandqueue(default).
- delay_seconds int
- Time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 seconds.
- fifo_queue bool
- Boolean designating a FIFO queue. If not set, it defaults to falsemaking it standard.
- fifo_throughput_ strlimit 
- Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue(default) andperMessageGroupId.
- kms_data_ intkey_ reuse_ period_ seconds 
- Length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
- kms_master_ strkey_ id 
- ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
- max_message_ intsize 
- Limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).
- message_retention_ intseconds 
- Number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).
- name str
- Name of the queue. Queue names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 80 characters long. For a FIFO (first-in-first-out) queue, the name must end with the .fifosuffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix.
- name_prefix str
- Creates a unique name beginning with the specified prefix. Conflicts with name.
- policy str
- JSON policy for the SQS queue. For more information about building AWS IAM policy documents with Pulumi, see the AWS IAM Policy Document Guide.
- receive_wait_ inttime_ seconds 
- Time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default for this attribute is 0, meaning that the call will return immediately.
- redrive_allow_ strpolicy 
- JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- redrive_policy str
- JSON policy to set up the Dead Letter Queue, see AWS docs. Note: when specifying maxReceiveCount, you must specify it as an integer (5), and not a string ("5").
- sqs_managed_ boolsse_ enabled 
- Boolean to enable server-side encryption (SSE) of message content with SQS-owned encryption keys. See Encryption at rest. The provider will only perform drift detection of its value when present in a configuration.
- Mapping[str, str]
- Map of tags to assign to the queue. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- url str
- Same as id: The URL for the created Amazon SQS queue.
- visibility_timeout_ intseconds 
- Visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see AWS docs.
- arn String
- ARN of the SQS queue.
- contentBased BooleanDeduplication 
- Enables content-based deduplication for FIFO queues. For more information, see the related documentation.
- deduplicationScope String
- Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroupandqueue(default).
- delaySeconds Number
- Time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 seconds.
- fifoQueue Boolean
- Boolean designating a FIFO queue. If not set, it defaults to falsemaking it standard.
- fifoThroughput StringLimit 
- Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue(default) andperMessageGroupId.
- kmsData NumberKey Reuse Period Seconds 
- Length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
- kmsMaster StringKey Id 
- ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
- maxMessage NumberSize 
- Limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB).
- messageRetention NumberSeconds 
- Number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).
- name String
- Name of the queue. Queue names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 80 characters long. For a FIFO (first-in-first-out) queue, the name must end with the .fifosuffix. If omitted, the provider will assign a random, unique name. Conflicts withname_prefix.
- namePrefix String
- Creates a unique name beginning with the specified prefix. Conflicts with name.
- policy String
- JSON policy for the SQS queue. For more information about building AWS IAM policy documents with Pulumi, see the AWS IAM Policy Document Guide.
- receiveWait NumberTime Seconds 
- Time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default for this attribute is 0, meaning that the call will return immediately.
- redriveAllow StringPolicy 
- JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- redrivePolicy String
- JSON policy to set up the Dead Letter Queue, see AWS docs. Note: when specifying maxReceiveCount, you must specify it as an integer (5), and not a string ("5").
- sqsManaged BooleanSse Enabled 
- Boolean to enable server-side encryption (SSE) of message content with SQS-owned encryption keys. See Encryption at rest. The provider will only perform drift detection of its value when present in a configuration.
- Map<String>
- Map of tags to assign to the queue. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Map<String>
- Map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- url String
- Same as id: The URL for the created Amazon SQS queue.
- visibilityTimeout NumberSeconds 
- Visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see AWS docs.
Import
Using pulumi import, import SQS Queues using the queue url. For example:
$ pulumi import aws:sqs/queue:Queue public_queue https://queue.amazonaws.com/80398EXAMPLE/MyQueue
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the awsTerraform Provider.