Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. sqs
  5. Queue

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.sqs.Queue

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
pulumi/pulumi-aws-native

    The AWS::SQS::Queue resource creates an SQS standard or FIFO queue. Keep the following caveats in mind:

    • If you don’t specify the FifoQueue property, SQS creates a standard queue. You can’t change the queue type after you create it and you can’t convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving from a standard queue to a FIFO queue in the Developer Guide.
    • If you don’t provide a value for a property, the queue is created with the default value for the property.
    • If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
    • To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.

    For more information about creating FIFO (first-in-first-out) queues, see Creating an queue () in the Developer Guide.

    Example Usage

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var alarmEmail = config.Get("alarmEmail") ?? "jane.doe@example.com";
    var myQueue = new AwsNative.Sqs.Queue("myQueue", new()
    {
        QueueName = "SampleQueue",
    });

    var alarmTopic = new AwsNative.Sns.Topic("alarmTopic", new()
    {
        Subscription = new[]
        {
            new AwsNative.Sns.Inputs.TopicSubscriptionArgs
            {
                Endpoint = alarmEmail,
                Protocol = "email",
            },
        },
    });

    var queueDepthAlarm = new AwsNative.CloudWatch.Alarm("queueDepthAlarm", new()
    {
        AlarmDescription = "Alarm if queue depth increases to more than 10 messages",
        Namespace = "AWS/SQS",
        MetricName = "ApproximateNumberOfMessagesVisible",
        Dimensions = new[]
        {
            new AwsNative.CloudWatch.Inputs.AlarmDimensionArgs
            {
                Name = "QueueName",
                Value = myQueue.QueueName,
            },
        },
        Statistic = "Sum",
        Period = 300,
        EvaluationPeriods = 1,
        Threshold = 10,
        ComparisonOperator = "GreaterThanThreshold",
        AlarmActions = new[]
        {
            alarmTopic.Id,
        },
        InsufficientDataActions = new[]
        {
            alarmTopic.Id,
        },
    });

    return new Dictionary<string, object?>
    {
        ["queueURL"] = myQueue.Id,
        ["queueARN"] = myQueue.Arn,
        ["queueName"] = myQueue.QueueName,
    };
});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/cloudwatch"
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/sns"
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/sqs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		alarmEmail := "jane.doe@example.com"
		if param := cfg.Get("alarmEmail"); param != "" {
			alarmEmail = param
		}
		myQueue, err := sqs.NewQueue(ctx, "myQueue", &sqs.QueueArgs{
			QueueName: pulumi.String("SampleQueue"),
		})
		if err != nil {
			return err
		}
		alarmTopic, err := sns.NewTopic(ctx, "alarmTopic", &sns.TopicArgs{
			Subscription: sns.TopicSubscriptionArray{
				&sns.TopicSubscriptionArgs{
					Endpoint: pulumi.String(alarmEmail),
					Protocol: pulumi.String("email"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = cloudwatch.NewAlarm(ctx, "queueDepthAlarm", &cloudwatch.AlarmArgs{
			AlarmDescription: pulumi.String("Alarm if queue depth increases to more than 10 messages"),
			Namespace:        pulumi.String("AWS/SQS"),
			MetricName:       pulumi.String("ApproximateNumberOfMessagesVisible"),
			Dimensions: cloudwatch.AlarmDimensionArray{
				&cloudwatch.AlarmDimensionArgs{
					Name:  pulumi.String("QueueName"),
					Value: myQueue.QueueName,
				},
			},
			Statistic:          pulumi.String("Sum"),
			Period:             pulumi.Int(300),
			EvaluationPeriods:  pulumi.Int(1),
			Threshold:          pulumi.Float64(10),
			ComparisonOperator: pulumi.String("GreaterThanThreshold"),
			AlarmActions: pulumi.StringArray{
				alarmTopic.ID(),
			},
			InsufficientDataActions: pulumi.StringArray{
				alarmTopic.ID(),
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("queueURL", myQueue.ID())
		ctx.Export("queueARN", myQueue.Arn)
		ctx.Export("queueName", myQueue.QueueName)
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

config = pulumi.Config()
alarm_email = config.get("alarmEmail")
if alarm_email is None:
    alarm_email = "jane.doe@example.com"
my_queue = aws_native.sqs.Queue("myQueue", queue_name="SampleQueue")
alarm_topic = aws_native.sns.Topic("alarmTopic", subscription=[aws_native.sns.TopicSubscriptionArgs(
    endpoint=alarm_email,
    protocol="email",
)])
queue_depth_alarm = aws_native.cloudwatch.Alarm("queueDepthAlarm",
    alarm_description="Alarm if queue depth increases to more than 10 messages",
    namespace="AWS/SQS",
    metric_name="ApproximateNumberOfMessagesVisible",
    dimensions=[aws_native.cloudwatch.AlarmDimensionArgs(
        name="QueueName",
        value=my_queue.queue_name,
    )],
    statistic="Sum",
    period=300,
    evaluation_periods=1,
    threshold=10,
    comparison_operator="GreaterThanThreshold",
    alarm_actions=[alarm_topic.id],
    insufficient_data_actions=[alarm_topic.id])
pulumi.export("queueURL", my_queue.id)
pulumi.export("queueARN", my_queue.arn)
pulumi.export("queueName", my_queue.queue_name)

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const config = new pulumi.Config();
const alarmEmail = config.get("alarmEmail") || "jane.doe@example.com";
const myQueue = new aws_native.sqs.Queue("myQueue", {queueName: "SampleQueue"});
const alarmTopic = new aws_native.sns.Topic("alarmTopic", {subscription: [{
    endpoint: alarmEmail,
    protocol: "email",
}]});
const queueDepthAlarm = new aws_native.cloudwatch.Alarm("queueDepthAlarm", {
    alarmDescription: "Alarm if queue depth increases to more than 10 messages",
    namespace: "AWS/SQS",
    metricName: "ApproximateNumberOfMessagesVisible",
    dimensions: [{
        name: "QueueName",
        value: myQueue.queueName,
    }],
    statistic: "Sum",
    period: 300,
    evaluationPeriods: 1,
    threshold: 10,
    comparisonOperator: "GreaterThanThreshold",
    alarmActions: [alarmTopic.id],
    insufficientDataActions: [alarmTopic.id],
});
export const queueURL = myQueue.id;
export const queueARN = myQueue.arn;
export const queueName = myQueue.queueName;

    Coming soon!

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var alarmEmail = config.Get("alarmEmail") ?? "jane.doe@example.com";
    var myQueue = new AwsNative.Sqs.Queue("myQueue", new()
    {
        QueueName = "SampleQueue",
    });

    var alarmTopic = new AwsNative.Sns.Topic("alarmTopic", new()
    {
        Subscription = new[]
        {
            new AwsNative.Sns.Inputs.TopicSubscriptionArgs
            {
                Endpoint = alarmEmail,
                Protocol = "email",
            },
        },
    });

    var queueDepthAlarm = new AwsNative.CloudWatch.Alarm("queueDepthAlarm", new()
    {
        AlarmDescription = "Alarm if queue depth increases to more than 10 messages",
        Namespace = "AWS/SQS",
        MetricName = "ApproximateNumberOfMessagesVisible",
        Dimensions = new[]
        {
            new AwsNative.CloudWatch.Inputs.AlarmDimensionArgs
            {
                Name = "QueueName",
                Value = myQueue.QueueName,
            },
        },
        Statistic = "Sum",
        Period = 300,
        EvaluationPeriods = 1,
        Threshold = 10,
        ComparisonOperator = "GreaterThanThreshold",
        AlarmActions = new[]
        {
            alarmTopic.Id,
        },
        InsufficientDataActions = new[]
        {
            alarmTopic.Id,
        },
    });

    return new Dictionary<string, object?>
    {
        ["queueURL"] = myQueue.Id,
        ["queueARN"] = myQueue.Arn,
        ["queueName"] = myQueue.QueueName,
    };
});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/cloudwatch"
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/sns"
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/sqs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		alarmEmail := "jane.doe@example.com"
		if param := cfg.Get("alarmEmail"); param != "" {
			alarmEmail = param
		}
		myQueue, err := sqs.NewQueue(ctx, "myQueue", &sqs.QueueArgs{
			QueueName: pulumi.String("SampleQueue"),
		})
		if err != nil {
			return err
		}
		alarmTopic, err := sns.NewTopic(ctx, "alarmTopic", &sns.TopicArgs{
			Subscription: sns.TopicSubscriptionArray{
				&sns.TopicSubscriptionArgs{
					Endpoint: pulumi.String(alarmEmail),
					Protocol: pulumi.String("email"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = cloudwatch.NewAlarm(ctx, "queueDepthAlarm", &cloudwatch.AlarmArgs{
			AlarmDescription: pulumi.String("Alarm if queue depth increases to more than 10 messages"),
			Namespace:        pulumi.String("AWS/SQS"),
			MetricName:       pulumi.String("ApproximateNumberOfMessagesVisible"),
			Dimensions: cloudwatch.AlarmDimensionArray{
				&cloudwatch.AlarmDimensionArgs{
					Name:  pulumi.String("QueueName"),
					Value: myQueue.QueueName,
				},
			},
			Statistic:          pulumi.String("Sum"),
			Period:             pulumi.Int(300),
			EvaluationPeriods:  pulumi.Int(1),
			Threshold:          pulumi.Float64(10),
			ComparisonOperator: pulumi.String("GreaterThanThreshold"),
			AlarmActions: pulumi.StringArray{
				alarmTopic.ID(),
			},
			InsufficientDataActions: pulumi.StringArray{
				alarmTopic.ID(),
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("queueURL", myQueue.ID())
		ctx.Export("queueARN", myQueue.Arn)
		ctx.Export("queueName", myQueue.QueueName)
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

config = pulumi.Config()
alarm_email = config.get("alarmEmail")
if alarm_email is None:
    alarm_email = "jane.doe@example.com"
my_queue = aws_native.sqs.Queue("myQueue", queue_name="SampleQueue")
alarm_topic = aws_native.sns.Topic("alarmTopic", subscription=[aws_native.sns.TopicSubscriptionArgs(
    endpoint=alarm_email,
    protocol="email",
)])
queue_depth_alarm = aws_native.cloudwatch.Alarm("queueDepthAlarm",
    alarm_description="Alarm if queue depth increases to more than 10 messages",
    namespace="AWS/SQS",
    metric_name="ApproximateNumberOfMessagesVisible",
    dimensions=[aws_native.cloudwatch.AlarmDimensionArgs(
        name="QueueName",
        value=my_queue.queue_name,
    )],
    statistic="Sum",
    period=300,
    evaluation_periods=1,
    threshold=10,
    comparison_operator="GreaterThanThreshold",
    alarm_actions=[alarm_topic.id],
    insufficient_data_actions=[alarm_topic.id])
pulumi.export("queueURL", my_queue.id)
pulumi.export("queueARN", my_queue.arn)
pulumi.export("queueName", my_queue.queue_name)

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const config = new pulumi.Config();
const alarmEmail = config.get("alarmEmail") || "jane.doe@example.com";
const myQueue = new aws_native.sqs.Queue("myQueue", {queueName: "SampleQueue"});
const alarmTopic = new aws_native.sns.Topic("alarmTopic", {subscription: [{
    endpoint: alarmEmail,
    protocol: "email",
}]});
const queueDepthAlarm = new aws_native.cloudwatch.Alarm("queueDepthAlarm", {
    alarmDescription: "Alarm if queue depth increases to more than 10 messages",
    namespace: "AWS/SQS",
    metricName: "ApproximateNumberOfMessagesVisible",
    dimensions: [{
        name: "QueueName",
        value: myQueue.queueName,
    }],
    statistic: "Sum",
    period: 300,
    evaluationPeriods: 1,
    threshold: 10,
    comparisonOperator: "GreaterThanThreshold",
    alarmActions: [alarmTopic.id],
    insufficientDataActions: [alarmTopic.id],
});
export const queueURL = myQueue.id;
export const queueARN = myQueue.arn;
export const queueName = myQueue.queueName;

    Coming soon!

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var myDeadLetterQueue = new AwsNative.Sqs.Queue("myDeadLetterQueue");

    var mySourceQueue = new AwsNative.Sqs.Queue("mySourceQueue", new()
    {
        RedrivePolicy = new Dictionary<string, object?>
        {
            ["deadLetterTargetArn"] = myDeadLetterQueue.Arn,
            ["maxReceiveCount"] = 5,
        },
    });

    return new Dictionary<string, object?>
    {
        ["sourceQueueURL"] = mySourceQueue.Id,
        ["sourceQueueARN"] = mySourceQueue.Arn,
        ["deadLetterQueueURL"] = myDeadLetterQueue.Id,
        ["deadLetterQueueARN"] = myDeadLetterQueue.Arn,
    };
});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/sqs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myDeadLetterQueue, err := sqs.NewQueue(ctx, "myDeadLetterQueue", nil)
		if err != nil {
			return err
		}
		mySourceQueue, err := sqs.NewQueue(ctx, "mySourceQueue", &sqs.QueueArgs{
			RedrivePolicy: pulumi.Any(map[string]interface{}{
				"deadLetterTargetArn": myDeadLetterQueue.Arn,
				"maxReceiveCount":     5,
			}),
		})
		if err != nil {
			return err
		}
		ctx.Export("sourceQueueURL", mySourceQueue.ID())
		ctx.Export("sourceQueueARN", mySourceQueue.Arn)
		ctx.Export("deadLetterQueueURL", myDeadLetterQueue.ID())
		ctx.Export("deadLetterQueueARN", myDeadLetterQueue.Arn)
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

my_dead_letter_queue = aws_native.sqs.Queue("myDeadLetterQueue")
my_source_queue = aws_native.sqs.Queue("mySourceQueue", redrive_policy={
    "deadLetterTargetArn": my_dead_letter_queue.arn,
    "maxReceiveCount": 5,
})
pulumi.export("sourceQueueURL", my_source_queue.id)
pulumi.export("sourceQueueARN", my_source_queue.arn)
pulumi.export("deadLetterQueueURL", my_dead_letter_queue.id)
pulumi.export("deadLetterQueueARN", my_dead_letter_queue.arn)

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const myDeadLetterQueue = new aws_native.sqs.Queue("myDeadLetterQueue", {});
const mySourceQueue = new aws_native.sqs.Queue("mySourceQueue", {redrivePolicy: {
    deadLetterTargetArn: myDeadLetterQueue.arn,
    maxReceiveCount: 5,
}});
export const sourceQueueURL = mySourceQueue.id;
export const sourceQueueARN = mySourceQueue.arn;
export const deadLetterQueueURL = myDeadLetterQueue.id;
export const deadLetterQueueARN = myDeadLetterQueue.arn;

    Coming soon!

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var myDeadLetterQueue = new AwsNative.Sqs.Queue("myDeadLetterQueue");

    var mySourceQueue = new AwsNative.Sqs.Queue("mySourceQueue", new()
    {
        RedrivePolicy = new Dictionary<string, object?>
        {
            ["deadLetterTargetArn"] = myDeadLetterQueue.Arn,
            ["maxReceiveCount"] = 5,
        },
    });

    return new Dictionary<string, object?>
    {
        ["sourceQueueURL"] = mySourceQueue.Id,
        ["sourceQueueARN"] = mySourceQueue.Arn,
        ["deadLetterQueueURL"] = myDeadLetterQueue.Id,
        ["deadLetterQueueARN"] = myDeadLetterQueue.Arn,
    };
});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/sqs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myDeadLetterQueue, err := sqs.NewQueue(ctx, "myDeadLetterQueue", nil)
		if err != nil {
			return err
		}
		mySourceQueue, err := sqs.NewQueue(ctx, "mySourceQueue", &sqs.QueueArgs{
			RedrivePolicy: pulumi.Any(map[string]interface{}{
				"deadLetterTargetArn": myDeadLetterQueue.Arn,
				"maxReceiveCount":     5,
			}),
		})
		if err != nil {
			return err
		}
		ctx.Export("sourceQueueURL", mySourceQueue.ID())
		ctx.Export("sourceQueueARN", mySourceQueue.Arn)
		ctx.Export("deadLetterQueueURL", myDeadLetterQueue.ID())
		ctx.Export("deadLetterQueueARN", myDeadLetterQueue.Arn)
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

my_dead_letter_queue = aws_native.sqs.Queue("myDeadLetterQueue")
my_source_queue = aws_native.sqs.Queue("mySourceQueue", redrive_policy={
    "deadLetterTargetArn": my_dead_letter_queue.arn,
    "maxReceiveCount": 5,
})
pulumi.export("sourceQueueURL", my_source_queue.id)
pulumi.export("sourceQueueARN", my_source_queue.arn)
pulumi.export("deadLetterQueueURL", my_dead_letter_queue.id)
pulumi.export("deadLetterQueueARN", my_dead_letter_queue.arn)

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const myDeadLetterQueue = new aws_native.sqs.Queue("myDeadLetterQueue", {});
const mySourceQueue = new aws_native.sqs.Queue("mySourceQueue", {redrivePolicy: {
    deadLetterTargetArn: myDeadLetterQueue.arn,
    maxReceiveCount: 5,
}});
export const sourceQueueURL = mySourceQueue.id;
export const sourceQueueARN = mySourceQueue.arn;
export const deadLetterQueueURL = myDeadLetterQueue.id;
export const deadLetterQueueARN = myDeadLetterQueue.arn;

    Coming soon!

    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,
          maximum_message_size: Optional[int] = None,
          message_retention_period: Optional[int] = None,
          queue_name: Optional[str] = None,
          receive_message_wait_time_seconds: Optional[int] = None,
          redrive_allow_policy: Optional[Any] = None,
          redrive_policy: Optional[Any] = None,
          sqs_managed_sse_enabled: Optional[bool] = None,
          tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
          visibility_timeout: 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)
    public Queue(String name, QueueArgs args)
public Queue(String name, QueueArgs args, CustomResourceOptions options)

    type: aws-native: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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const examplequeueResourceResourceFromSqs = new aws_native.sqs.Queue("examplequeueResourceResourceFromSqs", {
    contentBasedDeduplication: false,
    deduplicationScope: "string",
    delaySeconds: 0,
    fifoQueue: false,
    fifoThroughputLimit: "string",
    kmsDataKeyReusePeriodSeconds: 0,
    kmsMasterKeyId: "string",
    maximumMessageSize: 0,
    messageRetentionPeriod: 0,
    queueName: "string",
    receiveMessageWaitTimeSeconds: 0,
    redriveAllowPolicy: "any",
    redrivePolicy: "any",
    sqsManagedSseEnabled: false,
    tags: [{
        key: "string",
        value: "string",
    }],
    visibilityTimeout: 0,
});

    Coming soon!

    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:

    ContentBasedDeduplication bool
    For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ContentBasedDeduplication attribute for the CreateQueue action in the API Reference.
    DeduplicationScope string
    For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue. To enable high throughput for a FIFO queue, set this attribute to messageGroup and set the FifoThroughputLimit attribute to perMessageGroupId. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see High throughput for FIFO queues and Quotas related to messages in the Developer Guide.
    DelaySeconds int
    The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of 0 to 900 (15 minutes). The default value is 0.
    FifoQueue bool
    If set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see FIFO queues in the Developer Guide.
    FifoThroughputLimit string
    For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. To enable high throughput for a FIFO queue, set this attribute to perMessageGroupId and set the DeduplicationScope attribute to messageGroup. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see High throughput for FIFO queues and Quotas related to messages in the Developer Guide.
    KmsDataKeyReusePeriodSeconds int
    The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes). A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see Encryption at rest in the Developer Guide.
    KmsMasterKeyId string
    The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. alias/aws/sqs), key ARN, or key ID. For more information, see the following:

    MaximumMessageSize int
    The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default value is 262,144 (256 KiB).
    MessageRetentionPeriod int
    The number of seconds that SQS retains a message. You can specify an integer value from 60 seconds (1 minute) to 1,209,600 seconds (14 days). The default value is 345,600 seconds (4 days).
    QueueName string
    A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the .fifo suffix. For more information, see FIFO queues in the Developer Guide. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see Name type in the User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
    ReceiveMessageWaitTimeSeconds int
    Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see Consuming messages using long polling in the Developer Guide.
    RedriveAllowPolicy object

    The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:

    • redrivePermission: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:

    • allowAll: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.

    • denyAll: No source queues can specify this queue as the dead-letter queue.

    • byQueue: Only queues specified by the sourceQueueArns parameter can specify this queue as the dead-letter queue.

    • sourceQueueArns: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter to allowAll.

    Search the CloudFormation User Guide for AWS::SQS::Queue for more information about the expected schema for this property.

    RedrivePolicy object

    The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:

    • deadLetterTargetArn: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of maxReceiveCount is exceeded.
    • maxReceiveCount: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, SQS moves the message to the dead-letter-queue.

    The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. JSON { "deadLetterTargetArn" : String, "maxReceiveCount" : Integer } YAML deadLetterTargetArn : String maxReceiveCount : Integer

    Search the CloudFormation User Guide for AWS::SQS::Queue for more information about the expected schema for this property.

    SqsManagedSseEnabled bool
    Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS). When SqsManagedSseEnabled is not defined, SSE-SQS encryption is enabled by default.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags that you attach to this queue. For more information, see Resource tag in the User Guide.
    VisibilityTimeout int
    The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds. For more information about SQS queue visibility timeouts, see Visibility timeout in the Developer Guide.
    ContentBasedDeduplication bool
    For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ContentBasedDeduplication attribute for the CreateQueue action in the API Reference.
    DeduplicationScope string
    For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue. To enable high throughput for a FIFO queue, set this attribute to messageGroup and set the FifoThroughputLimit attribute to perMessageGroupId. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see High throughput for FIFO queues and Quotas related to messages in the Developer Guide.
    DelaySeconds int
    The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of 0 to 900 (15 minutes). The default value is 0.
    FifoQueue bool
    If set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see FIFO queues in the Developer Guide.
    FifoThroughputLimit string
    For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. To enable high throughput for a FIFO queue, set this attribute to perMessageGroupId and set the DeduplicationScope attribute to messageGroup. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see High throughput for FIFO queues and Quotas related to messages in the Developer Guide.
    KmsDataKeyReusePeriodSeconds int
    The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes). A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see Encryption at rest in the Developer Guide.
    KmsMasterKeyId string
    The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. alias/aws/sqs), key ARN, or key ID. For more information, see the following:

    MaximumMessageSize int
    The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default value is 262,144 (256 KiB).
    MessageRetentionPeriod int
    The number of seconds that SQS retains a message. You can specify an integer value from 60 seconds (1 minute) to 1,209,600 seconds (14 days). The default value is 345,600 seconds (4 days).
    QueueName string
    A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the .fifo suffix. For more information, see FIFO queues in the Developer Guide. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see Name type in the User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
    ReceiveMessageWaitTimeSeconds int
    Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see Consuming messages using long polling in the Developer Guide.
    RedriveAllowPolicy interface{}

    The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:

    • redrivePermission: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:

    • allowAll: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.

    • denyAll: No source queues can specify this queue as the dead-letter queue.

    • byQueue: Only queues specified by the sourceQueueArns parameter can specify this queue as the dead-letter queue.

    • sourceQueueArns: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter to allowAll.

    Search the CloudFormation User Guide for AWS::SQS::Queue for more information about the expected schema for this property.

    RedrivePolicy interface{}

    The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:

    • deadLetterTargetArn: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of maxReceiveCount is exceeded.
    • maxReceiveCount: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, SQS moves the message to the dead-letter-queue.

    The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. JSON { "deadLetterTargetArn" : String, "maxReceiveCount" : Integer } YAML deadLetterTargetArn : String maxReceiveCount : Integer

    Search the CloudFormation User Guide for AWS::SQS::Queue for more information about the expected schema for this property.

    SqsManagedSseEnabled bool
    Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS). When SqsManagedSseEnabled is not defined, SSE-SQS encryption is enabled by default.
    Tags TagArgs
    The tags that you attach to this queue. For more information, see Resource tag in the User Guide.
    VisibilityTimeout int
    The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds. For more information about SQS queue visibility timeouts, see Visibility timeout in the Developer Guide.
    contentBasedDeduplication Boolean
    For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ContentBasedDeduplication attribute for the CreateQueue action in the API Reference.
    deduplicationScope String
    For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue. To enable high throughput for a FIFO queue, set this attribute to messageGroup and set the FifoThroughputLimit attribute to perMessageGroupId. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see High throughput for FIFO queues and Quotas related to messages in the Developer Guide.
    delaySeconds Integer
    The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of 0 to 900 (15 minutes). The default value is 0.
    fifoQueue Boolean
    If set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see FIFO queues in the Developer Guide.
    fifoThroughputLimit String
    For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. To enable high throughput for a FIFO queue, set this attribute to perMessageGroupId and set the DeduplicationScope attribute to messageGroup. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see High throughput for FIFO queues and Quotas related to messages in the Developer Guide.
    kmsDataKeyReusePeriodSeconds Integer
    The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes). A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see Encryption at rest in the Developer Guide.
    kmsMasterKeyId String
    The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. alias/aws/sqs), key ARN, or key ID. For more information, see the following:

    maximumMessageSize Integer
    The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default value is 262,144 (256 KiB).
    messageRetentionPeriod Integer
    The number of seconds that SQS retains a message. You can specify an integer value from 60 seconds (1 minute) to 1,209,600 seconds (14 days). The default value is 345,600 seconds (4 days).
    queueName String
    A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the .fifo suffix. For more information, see FIFO queues in the Developer Guide. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see Name type in the User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
    receiveMessageWaitTimeSeconds Integer
    Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see Consuming messages using long polling in the Developer Guide.
    redriveAllowPolicy Object

    The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:

    • redrivePermission: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:

    • allowAll: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.

    • denyAll: No source queues can specify this queue as the dead-letter queue.

    • byQueue: Only queues specified by the sourceQueueArns parameter can specify this queue as the dead-letter queue.

    • sourceQueueArns: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter to allowAll.

    Search the CloudFormation User Guide for AWS::SQS::Queue for more information about the expected schema for this property.

    redrivePolicy Object

    The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:

    • deadLetterTargetArn: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of maxReceiveCount is exceeded.
    • maxReceiveCount: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, SQS moves the message to the dead-letter-queue.

    The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. JSON { "deadLetterTargetArn" : String, "maxReceiveCount" : Integer } YAML deadLetterTargetArn : String maxReceiveCount : Integer

    Search the CloudFormation User Guide for AWS::SQS::Queue for more information about the expected schema for this property.

    sqsManagedSseEnabled Boolean
    Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS). When SqsManagedSseEnabled is not defined, SSE-SQS encryption is enabled by default.
    tags List<Tag>
    The tags that you attach to this queue. For more information, see Resource tag in the User Guide.
    visibilityTimeout Integer
    The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds. For more information about SQS queue visibility timeouts, see Visibility timeout in the Developer Guide.
    contentBasedDeduplication boolean
    For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ContentBasedDeduplication attribute for the CreateQueue action in the API Reference.
    deduplicationScope string
    For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue. To enable high throughput for a FIFO queue, set this attribute to messageGroup and set the FifoThroughputLimit attribute to perMessageGroupId. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see High throughput for FIFO queues and Quotas related to messages in the Developer Guide.
    delaySeconds number
    The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of 0 to 900 (15 minutes). The default value is 0.
    fifoQueue boolean
    If set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see FIFO queues in the Developer Guide.
    fifoThroughputLimit string
    For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. To enable high throughput for a FIFO queue, set this attribute to perMessageGroupId and set the DeduplicationScope attribute to messageGroup. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see High throughput for FIFO queues and Quotas related to messages in the Developer Guide.
    kmsDataKeyReusePeriodSeconds number
    The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes). A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see Encryption at rest in the Developer Guide.
    kmsMasterKeyId string
    The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. alias/aws/sqs), key ARN, or key ID. For more information, see the following:

    maximumMessageSize number
    The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default value is 262,144 (256 KiB).
    messageRetentionPeriod number
    The number of seconds that SQS retains a message. You can specify an integer value from 60 seconds (1 minute) to 1,209,600 seconds (14 days). The default value is 345,600 seconds (4 days).
    queueName string
    A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the .fifo suffix. For more information, see FIFO queues in the Developer Guide. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see Name type in the User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
    receiveMessageWaitTimeSeconds number
    Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see Consuming messages using long polling in the Developer Guide.
    redriveAllowPolicy any

    The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:

    • redrivePermission: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:

    • allowAll: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.

    • denyAll: No source queues can specify this queue as the dead-letter queue.

    • byQueue: Only queues specified by the sourceQueueArns parameter can specify this queue as the dead-letter queue.

    • sourceQueueArns: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter to allowAll.

    Search the CloudFormation User Guide for AWS::SQS::Queue for more information about the expected schema for this property.

    redrivePolicy any

    The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:

    • deadLetterTargetArn: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of maxReceiveCount is exceeded.
    • maxReceiveCount: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, SQS moves the message to the dead-letter-queue.

    The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. JSON { "deadLetterTargetArn" : String, "maxReceiveCount" : Integer } YAML deadLetterTargetArn : String maxReceiveCount : Integer

    Search the CloudFormation User Guide for AWS::SQS::Queue for more information about the expected schema for this property.

    sqsManagedSseEnabled boolean
    Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS). When SqsManagedSseEnabled is not defined, SSE-SQS encryption is enabled by default.
    tags Tag[]
    The tags that you attach to this queue. For more information, see Resource tag in the User Guide.
    visibilityTimeout number
    The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds. For more information about SQS queue visibility timeouts, see Visibility timeout in the Developer Guide.
    content_based_deduplication bool
    For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ContentBasedDeduplication attribute for the CreateQueue action in the API Reference.
    deduplication_scope str
    For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue. To enable high throughput for a FIFO queue, set this attribute to messageGroup and set the FifoThroughputLimit attribute to perMessageGroupId. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see High throughput for FIFO queues and Quotas related to messages in the Developer Guide.
    delay_seconds int
    The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of 0 to 900 (15 minutes). The default value is 0.
    fifo_queue bool
    If set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see FIFO queues in the Developer Guide.
    fifo_throughput_limit str
    For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. To enable high throughput for a FIFO queue, set this attribute to perMessageGroupId and set the DeduplicationScope attribute to messageGroup. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see High throughput for FIFO queues and Quotas related to messages in the Developer Guide.
    kms_data_key_reuse_period_seconds int
    The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes). A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see Encryption at rest in the Developer Guide.
    kms_master_key_id str
    The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. alias/aws/sqs), key ARN, or key ID. For more information, see the following:

    maximum_message_size int
    The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default value is 262,144 (256 KiB).
    message_retention_period int
    The number of seconds that SQS retains a message. You can specify an integer value from 60 seconds (1 minute) to 1,209,600 seconds (14 days). The default value is 345,600 seconds (4 days).
    queue_name str
    A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the .fifo suffix. For more information, see FIFO queues in the Developer Guide. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see Name type in the User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
    receive_message_wait_time_seconds int
    Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see Consuming messages using long polling in the Developer Guide.
    redrive_allow_policy Any

    The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:

    • redrivePermission: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:

    • allowAll: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.

    • denyAll: No source queues can specify this queue as the dead-letter queue.

    • byQueue: Only queues specified by the sourceQueueArns parameter can specify this queue as the dead-letter queue.

    • sourceQueueArns: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter to allowAll.

    Search the CloudFormation User Guide for AWS::SQS::Queue for more information about the expected schema for this property.

    redrive_policy Any

    The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:

    • deadLetterTargetArn: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of maxReceiveCount is exceeded.
    • maxReceiveCount: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, SQS moves the message to the dead-letter-queue.

    The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. JSON { "deadLetterTargetArn" : String, "maxReceiveCount" : Integer } YAML deadLetterTargetArn : String maxReceiveCount : Integer

    Search the CloudFormation User Guide for AWS::SQS::Queue for more information about the expected schema for this property.

    sqs_managed_sse_enabled bool
    Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS). When SqsManagedSseEnabled is not defined, SSE-SQS encryption is enabled by default.
    tags Sequence[TagArgs]
    The tags that you attach to this queue. For more information, see Resource tag in the User Guide.
    visibility_timeout int
    The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds. For more information about SQS queue visibility timeouts, see Visibility timeout in the Developer Guide.
    contentBasedDeduplication Boolean
    For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ContentBasedDeduplication attribute for the CreateQueue action in the API Reference.
    deduplicationScope String
    For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue. To enable high throughput for a FIFO queue, set this attribute to messageGroup and set the FifoThroughputLimit attribute to perMessageGroupId. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see High throughput for FIFO queues and Quotas related to messages in the Developer Guide.
    delaySeconds Number
    The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of 0 to 900 (15 minutes). The default value is 0.
    fifoQueue Boolean
    If set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see FIFO queues in the Developer Guide.
    fifoThroughputLimit String
    For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. To enable high throughput for a FIFO queue, set this attribute to perMessageGroupId and set the DeduplicationScope attribute to messageGroup. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see High throughput for FIFO queues and Quotas related to messages in the Developer Guide.
    kmsDataKeyReusePeriodSeconds Number
    The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes). A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see Encryption at rest in the Developer Guide.
    kmsMasterKeyId String
    The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. alias/aws/sqs), key ARN, or key ID. For more information, see the following:

    maximumMessageSize Number
    The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default value is 262,144 (256 KiB).
    messageRetentionPeriod Number
    The number of seconds that SQS retains a message. You can specify an integer value from 60 seconds (1 minute) to 1,209,600 seconds (14 days). The default value is 345,600 seconds (4 days).
    queueName String
    A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the .fifo suffix. For more information, see FIFO queues in the Developer Guide. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see Name type in the User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
    receiveMessageWaitTimeSeconds Number
    Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see Consuming messages using long polling in the Developer Guide.
    redriveAllowPolicy Any

    The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:

    • redrivePermission: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:

    • allowAll: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.

    • denyAll: No source queues can specify this queue as the dead-letter queue.

    • byQueue: Only queues specified by the sourceQueueArns parameter can specify this queue as the dead-letter queue.

    • sourceQueueArns: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter to allowAll.

    Search the CloudFormation User Guide for AWS::SQS::Queue for more information about the expected schema for this property.

    redrivePolicy Any

    The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:

    • deadLetterTargetArn: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of maxReceiveCount is exceeded.
    • maxReceiveCount: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, SQS moves the message to the dead-letter-queue.

    The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. JSON { "deadLetterTargetArn" : String, "maxReceiveCount" : Integer } YAML deadLetterTargetArn : String maxReceiveCount : Integer

    Search the CloudFormation User Guide for AWS::SQS::Queue for more information about the expected schema for this property.

    sqsManagedSseEnabled Boolean
    Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS). When SqsManagedSseEnabled is not defined, SSE-SQS encryption is enabled by default.
    tags List<Property Map>
    The tags that you attach to this queue. For more information, see Resource tag in the User Guide.
    visibilityTimeout Number
    The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds. For more information about SQS queue visibility timeouts, see Visibility timeout in the Developer Guide.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Queue resource produces the following output properties:

    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    QueueUrl string
    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    QueueUrl string
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    queueUrl String
    arn string
    id string
    The provider-assigned unique ID for this managed resource.
    queueUrl string
    arn str
    id str
    The provider-assigned unique ID for this managed resource.
    queue_url str
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    queueUrl String

    Supporting Types

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
    pulumi/pulumi-aws-native