Try AWS Native preview for resources not in the classic version.
aws.sqs.Queue
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
FIFO queue
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const queue = new aws.sqs.Queue("queue", {
contentBasedDeduplication: true,
fifoQueue: true,
});
import pulumi
import pulumi_aws as aws
queue = aws.sqs.Queue("queue",
content_based_deduplication=True,
fifo_queue=True)
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()
{
ContentBasedDeduplication = true,
FifoQueue = 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{
ContentBasedDeduplication: pulumi.Bool(true),
FifoQueue: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
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()
.contentBasedDeduplication(true)
.fifoQueue(true)
.build());
}
}
resources:
queue:
type: aws:sqs:Queue
properties:
contentBasedDeduplication: true
fifoQueue: true
High-throughput FIFO queue
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const queue = new aws.sqs.Queue("queue", {
deduplicationScope: "messageGroup",
fifoQueue: true,
fifoThroughputLimit: "perMessageGroupId",
});
import pulumi
import pulumi_aws as aws
queue = aws.sqs.Queue("queue",
deduplication_scope="messageGroup",
fifo_queue=True,
fifo_throughput_limit="perMessageGroupId")
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()
{
DeduplicationScope = "messageGroup",
FifoQueue = true,
FifoThroughputLimit = "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{
DeduplicationScope: pulumi.String("messageGroup"),
FifoQueue: pulumi.Bool(true),
FifoThroughputLimit: pulumi.String("perMessageGroupId"),
})
if err != nil {
return err
}
return nil
})
}
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()
.deduplicationScope("messageGroup")
.fifoQueue(true)
.fifoThroughputLimit("perMessageGroupId")
.build());
}
}
resources:
queue:
type: aws:sqs:Queue
properties:
deduplicationScope: messageGroup
fifoQueue: true
fifoThroughputLimit: perMessageGroupId
Dead-letter queue
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const exampleQueueDeadletter = new aws.sqs.Queue("exampleQueueDeadletter", {redriveAllowPolicy: JSON.stringify({
redrivePermission: "byQueue",
sourceQueueArns: [aws_sqs_queue.example_queue.arn],
})});
import pulumi
import json
import pulumi_aws as aws
example_queue_deadletter = aws.sqs.Queue("exampleQueueDeadletter", redrive_allow_policy=json.dumps({
"redrivePermission": "byQueue",
"sourceQueueArns": [aws_sqs_queue["example_queue"]["arn"]],
}))
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var exampleQueueDeadletter = new Aws.Sqs.Queue("exampleQueueDeadletter", new()
{
RedriveAllowPolicy = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["redrivePermission"] = "byQueue",
["sourceQueueArns"] = new[]
{
aws_sqs_queue.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{}{
"redrivePermission": "byQueue",
"sourceQueueArns": []interface{}{
aws_sqs_queue.Example_queue.Arn,
},
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = sqs.NewQueue(ctx, "exampleQueueDeadletter", &sqs.QueueArgs{
RedriveAllowPolicy: pulumi.String(json0),
})
if err != nil {
return err
}
return nil
})
}
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 exampleQueueDeadletter = new Queue("exampleQueueDeadletter", QueueArgs.builder()
.redriveAllowPolicy(serializeJson(
jsonObject(
jsonProperty("redrivePermission", "byQueue"),
jsonProperty("sourceQueueArns", jsonArray(aws_sqs_queue.example_queue().arn()))
)))
.build());
}
}
resources:
exampleQueueDeadletter:
type: aws:sqs:Queue
properties:
redriveAllowPolicy:
fn::toJSON:
redrivePermission: byQueue
sourceQueueArns:
- ${aws_sqs_queue.example_queue.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", {sqsManagedSseEnabled: true});
import pulumi
import pulumi_aws as aws
queue = aws.sqs.Queue("queue", sqs_managed_sse_enabled=True)
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()
{
SqsManagedSseEnabled = 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{
SqsManagedSseEnabled: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
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()
.sqsManagedSseEnabled(true)
.build());
}
}
resources:
queue:
type: aws:sqs:Queue
properties:
sqsManagedSseEnabled: true
Using SSE-KMS:
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const queue = new aws.sqs.Queue("queue", {
kmsDataKeyReusePeriodSeconds: 300,
kmsMasterKeyId: "alias/aws/sqs",
});
import pulumi
import pulumi_aws as aws
queue = aws.sqs.Queue("queue",
kms_data_key_reuse_period_seconds=300,
kms_master_key_id="alias/aws/sqs")
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()
{
KmsDataKeyReusePeriodSeconds = 300,
KmsMasterKeyId = "alias/aws/sqs",
});
});
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{
KmsDataKeyReusePeriodSeconds: pulumi.Int(300),
KmsMasterKeyId: pulumi.String("alias/aws/sqs"),
})
if err != nil {
return err
}
return nil
})
}
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()
.kmsDataKeyReusePeriodSeconds(300)
.kmsMasterKeyId("alias/aws/sqs")
.build());
}
}
resources:
queue:
type: aws:sqs:Queue
properties:
kmsDataKeyReusePeriodSeconds: 300
kmsMasterKeyId: alias/aws/sqs
Example Usage
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()
{
DelaySeconds = 90,
MaxMessageSize = 2048,
MessageRetentionSeconds = 86400,
ReceiveWaitTimeSeconds = 10,
RedrivePolicy = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["deadLetterTargetArn"] = aws_sqs_queue.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": aws_sqs_queue.Queue_deadletter.Arn,
"maxReceiveCount": 4,
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = sqs.NewQueue(ctx, "queue", &sqs.QueueArgs{
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
})
}
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()
.delaySeconds(90)
.maxMessageSize(2048)
.messageRetentionSeconds(86400)
.receiveWaitTimeSeconds(10)
.redrivePolicy(serializeJson(
jsonObject(
jsonProperty("deadLetterTargetArn", aws_sqs_queue.queue_deadletter().arn()),
jsonProperty("maxReceiveCount", 4)
)))
.tags(Map.of("Environment", "production"))
.build());
}
}
import pulumi
import json
import pulumi_aws as aws
queue = aws.sqs.Queue("queue",
delay_seconds=90,
max_message_size=2048,
message_retention_seconds=86400,
receive_wait_time_seconds=10,
redrive_policy=json.dumps({
"deadLetterTargetArn": aws_sqs_queue["queue_deadletter"]["arn"],
"maxReceiveCount": 4,
}),
tags={
"Environment": "production",
})
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const queue = new aws.sqs.Queue("queue", {
delaySeconds: 90,
maxMessageSize: 2048,
messageRetentionSeconds: 86400,
receiveWaitTimeSeconds: 10,
redrivePolicy: JSON.stringify({
deadLetterTargetArn: aws_sqs_queue.queue_deadletter.arn,
maxReceiveCount: 4,
}),
tags: {
Environment: "production",
},
});
resources:
queue:
type: aws:sqs:Queue
properties:
delaySeconds: 90
maxMessageSize: 2048
messageRetentionSeconds: 86400
receiveWaitTimeSeconds: 10
redrivePolicy:
fn::toJSON:
deadLetterTargetArn: ${aws_sqs_queue.queue_deadletter.arn}
maxReceiveCount: 4
tags:
Environment: production
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()
{
ContentBasedDeduplication = true,
FifoQueue = 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{
ContentBasedDeduplication: pulumi.Bool(true),
FifoQueue: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
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()
.contentBasedDeduplication(true)
.fifoQueue(true)
.build());
}
}
import pulumi
import pulumi_aws as aws
queue = aws.sqs.Queue("queue",
content_based_deduplication=True,
fifo_queue=True)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const queue = new aws.sqs.Queue("queue", {
contentBasedDeduplication: true,
fifoQueue: true,
});
resources:
queue:
type: aws:sqs:Queue
properties:
contentBasedDeduplication: true
fifoQueue: true
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()
{
DeduplicationScope = "messageGroup",
FifoQueue = true,
FifoThroughputLimit = "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{
DeduplicationScope: pulumi.String("messageGroup"),
FifoQueue: pulumi.Bool(true),
FifoThroughputLimit: pulumi.String("perMessageGroupId"),
})
if err != nil {
return err
}
return nil
})
}
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()
.deduplicationScope("messageGroup")
.fifoQueue(true)
.fifoThroughputLimit("perMessageGroupId")
.build());
}
}
import pulumi
import pulumi_aws as aws
queue = aws.sqs.Queue("queue",
deduplication_scope="messageGroup",
fifo_queue=True,
fifo_throughput_limit="perMessageGroupId")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const queue = new aws.sqs.Queue("queue", {
deduplicationScope: "messageGroup",
fifoQueue: true,
fifoThroughputLimit: "perMessageGroupId",
});
resources:
queue:
type: aws:sqs:Queue
properties:
deduplicationScope: messageGroup
fifoQueue: true
fifoThroughputLimit: perMessageGroupId
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var exampleQueueDeadletter = new Aws.Sqs.Queue("exampleQueueDeadletter", new()
{
RedriveAllowPolicy = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["redrivePermission"] = "byQueue",
["sourceQueueArns"] = new[]
{
aws_sqs_queue.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{}{
"redrivePermission": "byQueue",
"sourceQueueArns": []interface{}{
aws_sqs_queue.Example_queue.Arn,
},
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = sqs.NewQueue(ctx, "exampleQueueDeadletter", &sqs.QueueArgs{
RedriveAllowPolicy: pulumi.String(json0),
})
if err != nil {
return err
}
return nil
})
}
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 exampleQueueDeadletter = new Queue("exampleQueueDeadletter", QueueArgs.builder()
.redriveAllowPolicy(serializeJson(
jsonObject(
jsonProperty("redrivePermission", "byQueue"),
jsonProperty("sourceQueueArns", jsonArray(aws_sqs_queue.example_queue().arn()))
)))
.build());
}
}
import pulumi
import json
import pulumi_aws as aws
example_queue_deadletter = aws.sqs.Queue("exampleQueueDeadletter", redrive_allow_policy=json.dumps({
"redrivePermission": "byQueue",
"sourceQueueArns": [aws_sqs_queue["example_queue"]["arn"]],
}))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const exampleQueueDeadletter = new aws.sqs.Queue("exampleQueueDeadletter", {redriveAllowPolicy: JSON.stringify({
redrivePermission: "byQueue",
sourceQueueArns: [aws_sqs_queue.example_queue.arn],
})});
resources:
exampleQueueDeadletter:
type: aws:sqs:Queue
properties:
redriveAllowPolicy:
fn::toJSON:
redrivePermission: byQueue
sourceQueueArns:
- ${aws_sqs_queue.example_queue.arn}
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()
{
SqsManagedSseEnabled = 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{
SqsManagedSseEnabled: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
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()
.sqsManagedSseEnabled(true)
.build());
}
}
import pulumi
import pulumi_aws as aws
queue = aws.sqs.Queue("queue", sqs_managed_sse_enabled=True)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const queue = new aws.sqs.Queue("queue", {sqsManagedSseEnabled: true});
resources:
queue:
type: aws:sqs:Queue
properties:
sqsManagedSseEnabled: true
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()
{
KmsDataKeyReusePeriodSeconds = 300,
KmsMasterKeyId = "alias/aws/sqs",
});
});
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{
KmsDataKeyReusePeriodSeconds: pulumi.Int(300),
KmsMasterKeyId: pulumi.String("alias/aws/sqs"),
})
if err != nil {
return err
}
return nil
})
}
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()
.kmsDataKeyReusePeriodSeconds(300)
.kmsMasterKeyId("alias/aws/sqs")
.build());
}
}
import pulumi
import pulumi_aws as aws
queue = aws.sqs.Queue("queue",
kms_data_key_reuse_period_seconds=300,
kms_master_key_id="alias/aws/sqs")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const queue = new aws.sqs.Queue("queue", {
kmsDataKeyReusePeriodSeconds: 300,
kmsMasterKeyId: "alias/aws/sqs",
});
resources:
queue:
type: aws:sqs:Queue
properties:
kmsDataKeyReusePeriodSeconds: 300
kmsMasterKeyId: alias/aws/sqs
Create Queue Resource
new Queue(name: string, args?: QueueArgs, opts?: CustomResourceOptions);
@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)
@overload
def Queue(resource_name: str,
args: Optional[QueueArgs] = None,
opts: Optional[ResourceOptions] = 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.
- 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.
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
The Queue resource accepts the following input properties:
- Content
Based boolDeduplication Enables content-based deduplication for FIFO queues. For more information, see the related documentation
- Deduplication
Scope string Specifies whether message deduplication occurs at the message group or queue level. Valid values are
messageGroup
andqueue
(default).- Delay
Seconds int The 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
false
making it standard.- Fifo
Throughput stringLimit 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 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. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
- Kms
Master stringKey Id The 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 The 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 The 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
The 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
.fifo
suffix. If omitted, this provider will assign a random, unique name. Conflicts withname_prefix
- Name
Prefix string Creates a unique name beginning with the specified prefix. Conflicts with
name
- Policy string
The JSON policy for the SQS queue.
- Receive
Wait intTime Seconds The 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 stringPolicy The JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- Redrive
Policy string The 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.
- Dictionary<string, string>
A map of tags to assign to the queue. If configured with a provider
default_tags
configuration block) present, tags with matching keys will overwrite those defined at the provider-level.- Visibility
Timeout intSeconds The 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 string Specifies whether message deduplication occurs at the message group or queue level. Valid values are
messageGroup
andqueue
(default).- Delay
Seconds int The 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
false
making it standard.- Fifo
Throughput stringLimit 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 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. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
- Kms
Master stringKey Id The 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 The 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 The 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
The 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
.fifo
suffix. If omitted, this provider will assign a random, unique name. Conflicts withname_prefix
- Name
Prefix string Creates a unique name beginning with the specified prefix. Conflicts with
name
- Policy string
The JSON policy for the SQS queue.
- Receive
Wait intTime Seconds The 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 stringPolicy The JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- Redrive
Policy string The 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.
- map[string]string
A map of tags to assign to the queue. If configured with a provider
default_tags
configuration block) present, tags with matching keys will overwrite those defined at the provider-level.- Visibility
Timeout intSeconds The 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 BooleanDeduplication Enables content-based deduplication for FIFO queues. For more information, see the related documentation
- deduplication
Scope String Specifies whether message deduplication occurs at the message group or queue level. Valid values are
messageGroup
andqueue
(default).- delay
Seconds Integer The 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 Boolean Boolean designating a FIFO queue. If not set, it defaults to
false
making it standard.- fifo
Throughput StringLimit Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are
perQueue
(default) andperMessageGroupId
.- kms
Data IntegerKey Reuse Period Seconds 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. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
- kms
Master StringKey Id The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
- max
Message IntegerSize The 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 IntegerSeconds The 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
The 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
.fifo
suffix. If omitted, this provider will assign a random, unique name. Conflicts withname_prefix
- name
Prefix String Creates a unique name beginning with the specified prefix. Conflicts with
name
- policy String
The JSON policy for the SQS queue.
- receive
Wait IntegerTime Seconds The 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 StringPolicy The JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- redrive
Policy String The 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 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>
A map of tags to assign to the queue. If configured with a provider
default_tags
configuration block) present, tags with matching keys will overwrite those defined at the provider-level.- visibility
Timeout IntegerSeconds The 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 booleanDeduplication Enables content-based deduplication for FIFO queues. For more information, see the related documentation
- deduplication
Scope string Specifies whether message deduplication occurs at the message group or queue level. Valid values are
messageGroup
andqueue
(default).- delay
Seconds number The 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 boolean Boolean designating a FIFO queue. If not set, it defaults to
false
making it standard.- fifo
Throughput stringLimit Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are
perQueue
(default) andperMessageGroupId
.- kms
Data numberKey Reuse Period Seconds 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. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
- kms
Master stringKey Id The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
- max
Message numberSize The 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 numberSeconds The 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
The 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
.fifo
suffix. If omitted, this provider will assign a random, unique name. Conflicts withname_prefix
- name
Prefix string Creates a unique name beginning with the specified prefix. Conflicts with
name
- policy string
The JSON policy for the SQS queue.
- receive
Wait numberTime Seconds The 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 stringPolicy The JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- redrive
Policy string The 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 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}
A map of tags to assign to the queue. If configured with a provider
default_tags
configuration block) present, tags with matching keys will overwrite those defined at the provider-level.- visibility
Timeout numberSeconds The 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
messageGroup
andqueue
(default).- delay_
seconds int The 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
false
making 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 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. 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 The 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 The 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 The 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
The 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
.fifo
suffix. If omitted, this 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
The JSON policy for the SQS queue.
- receive_
wait_ inttime_ seconds The 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 The JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- redrive_
policy str The 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]
A map of tags to assign to the queue. If configured with a provider
default_tags
configuration block) present, tags with matching keys will overwrite those defined at the provider-level.- visibility_
timeout_ intseconds The 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 BooleanDeduplication Enables content-based deduplication for FIFO queues. For more information, see the related documentation
- deduplication
Scope String Specifies whether message deduplication occurs at the message group or queue level. Valid values are
messageGroup
andqueue
(default).- delay
Seconds Number The 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 Boolean Boolean designating a FIFO queue. If not set, it defaults to
false
making it standard.- fifo
Throughput StringLimit Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are
perQueue
(default) andperMessageGroupId
.- kms
Data NumberKey Reuse Period Seconds 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. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
- kms
Master StringKey Id The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
- max
Message NumberSize The 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 NumberSeconds The 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
The 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
.fifo
suffix. If omitted, this provider will assign a random, unique name. Conflicts withname_prefix
- name
Prefix String Creates a unique name beginning with the specified prefix. Conflicts with
name
- policy String
The JSON policy for the SQS queue.
- receive
Wait NumberTime Seconds The 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 StringPolicy The JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- redrive
Policy String The 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 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>
A map of tags to assign to the queue. If configured with a provider
default_tags
configuration block) present, tags with matching keys will overwrite those defined at the provider-level.- visibility
Timeout NumberSeconds The 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
The ARN of the SQS queue
- Id string
The provider-assigned unique ID for this managed resource.
- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- Url string
Same as
id
: The URL for the created Amazon SQS queue.
- Arn string
The ARN of the SQS queue
- Id string
The provider-assigned unique ID for this managed resource.
- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- Url string
Same as
id
: The URL for the created Amazon SQS queue.
- arn String
The ARN of the SQS queue
- id String
The provider-assigned unique ID for this managed resource.
- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- url String
Same as
id
: The URL for the created Amazon SQS queue.
- arn string
The ARN of the SQS queue
- id string
The provider-assigned unique ID for this managed resource.
- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- url string
Same as
id
: The URL for the created Amazon SQS queue.
- arn str
The ARN of the SQS queue
- id str
The provider-assigned unique ID for this managed resource.
- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- url str
Same as
id
: The URL for the created Amazon SQS queue.
- arn String
The ARN of the SQS queue
- id String
The provider-assigned unique ID for this managed resource.
- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- 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) -> Queue
func 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)
Resource lookup is not supported in YAML
- 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
The ARN of the SQS queue
- Content
Based boolDeduplication Enables content-based deduplication for FIFO queues. For more information, see the related documentation
- Deduplication
Scope string Specifies whether message deduplication occurs at the message group or queue level. Valid values are
messageGroup
andqueue
(default).- Delay
Seconds int The 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
false
making it standard.- Fifo
Throughput stringLimit 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 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. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
- Kms
Master stringKey Id The 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 The 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 The 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
The 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
.fifo
suffix. If omitted, this provider will assign a random, unique name. Conflicts withname_prefix
- Name
Prefix string Creates a unique name beginning with the specified prefix. Conflicts with
name
- Policy string
The JSON policy for the SQS queue.
- Receive
Wait intTime Seconds The 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 stringPolicy The JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- Redrive
Policy string The 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.
- Dictionary<string, string>
A map of tags to assign to the queue. If configured with a provider
default_tags
configuration block) present, tags with matching keys will overwrite those defined at the provider-level.- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- Url string
Same as
id
: The URL for the created Amazon SQS queue.- Visibility
Timeout intSeconds The 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
The ARN of the SQS queue
- Content
Based boolDeduplication Enables content-based deduplication for FIFO queues. For more information, see the related documentation
- Deduplication
Scope string Specifies whether message deduplication occurs at the message group or queue level. Valid values are
messageGroup
andqueue
(default).- Delay
Seconds int The 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
false
making it standard.- Fifo
Throughput stringLimit 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 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. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
- Kms
Master stringKey Id The 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 The 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 The 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
The 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
.fifo
suffix. If omitted, this provider will assign a random, unique name. Conflicts withname_prefix
- Name
Prefix string Creates a unique name beginning with the specified prefix. Conflicts with
name
- Policy string
The JSON policy for the SQS queue.
- Receive
Wait intTime Seconds The 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 stringPolicy The JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- Redrive
Policy string The 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.
- map[string]string
A map of tags to assign to the queue. If configured with a provider
default_tags
configuration block) present, tags with matching keys will overwrite those defined at the provider-level.- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- Url string
Same as
id
: The URL for the created Amazon SQS queue.- Visibility
Timeout intSeconds The 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
The ARN of the SQS queue
- content
Based BooleanDeduplication Enables content-based deduplication for FIFO queues. For more information, see the related documentation
- deduplication
Scope String Specifies whether message deduplication occurs at the message group or queue level. Valid values are
messageGroup
andqueue
(default).- delay
Seconds Integer The 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 Boolean Boolean designating a FIFO queue. If not set, it defaults to
false
making it standard.- fifo
Throughput StringLimit Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are
perQueue
(default) andperMessageGroupId
.- kms
Data IntegerKey Reuse Period Seconds 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. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
- kms
Master StringKey Id The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
- max
Message IntegerSize The 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 IntegerSeconds The 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
The 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
.fifo
suffix. If omitted, this provider will assign a random, unique name. Conflicts withname_prefix
- name
Prefix String Creates a unique name beginning with the specified prefix. Conflicts with
name
- policy String
The JSON policy for the SQS queue.
- receive
Wait IntegerTime Seconds The 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 StringPolicy The JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- redrive
Policy String The 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 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>
A map of tags to assign to the queue. If configured with a provider
default_tags
configuration block) present, tags with matching keys will overwrite those defined at the provider-level.- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- url String
Same as
id
: The URL for the created Amazon SQS queue.- visibility
Timeout IntegerSeconds The 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
The ARN of the SQS queue
- content
Based booleanDeduplication Enables content-based deduplication for FIFO queues. For more information, see the related documentation
- deduplication
Scope string Specifies whether message deduplication occurs at the message group or queue level. Valid values are
messageGroup
andqueue
(default).- delay
Seconds number The 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 boolean Boolean designating a FIFO queue. If not set, it defaults to
false
making it standard.- fifo
Throughput stringLimit Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are
perQueue
(default) andperMessageGroupId
.- kms
Data numberKey Reuse Period Seconds 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. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
- kms
Master stringKey Id The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
- max
Message numberSize The 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 numberSeconds The 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
The 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
.fifo
suffix. If omitted, this provider will assign a random, unique name. Conflicts withname_prefix
- name
Prefix string Creates a unique name beginning with the specified prefix. Conflicts with
name
- policy string
The JSON policy for the SQS queue.
- receive
Wait numberTime Seconds The 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 stringPolicy The JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- redrive
Policy string The 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 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}
A map of tags to assign to the queue. If configured with a provider
default_tags
configuration block) present, tags with matching keys will overwrite those defined at the provider-level.- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- url string
Same as
id
: The URL for the created Amazon SQS queue.- visibility
Timeout numberSeconds The 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
The 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
messageGroup
andqueue
(default).- delay_
seconds int The 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
false
making 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 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. 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 The 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 The 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 The 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
The 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
.fifo
suffix. If omitted, this 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
The JSON policy for the SQS queue.
- receive_
wait_ inttime_ seconds The 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 The JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- redrive_
policy str The 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]
A map of tags to assign to the queue. If configured with a provider
default_tags
configuration block) present, tags with matching keys will overwrite those defined at the provider-level.- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- url str
Same as
id
: The URL for the created Amazon SQS queue.- visibility_
timeout_ intseconds The 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
The ARN of the SQS queue
- content
Based BooleanDeduplication Enables content-based deduplication for FIFO queues. For more information, see the related documentation
- deduplication
Scope String Specifies whether message deduplication occurs at the message group or queue level. Valid values are
messageGroup
andqueue
(default).- delay
Seconds Number The 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 Boolean Boolean designating a FIFO queue. If not set, it defaults to
false
making it standard.- fifo
Throughput StringLimit Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are
perQueue
(default) andperMessageGroupId
.- kms
Data NumberKey Reuse Period Seconds 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. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
- kms
Master StringKey Id The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
- max
Message NumberSize The 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 NumberSeconds The 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
The 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
.fifo
suffix. If omitted, this provider will assign a random, unique name. Conflicts withname_prefix
- name
Prefix String Creates a unique name beginning with the specified prefix. Conflicts with
name
- policy String
The JSON policy for the SQS queue.
- receive
Wait NumberTime Seconds The 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 StringPolicy The JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs.
- redrive
Policy String The 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 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>
A map of tags to assign to the queue. If configured with a provider
default_tags
configuration block) present, tags with matching keys will overwrite those defined at the provider-level.- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- url String
Same as
id
: The URL for the created Amazon SQS queue.- visibility
Timeout NumberSeconds The 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
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.