AWS Cloud Control v1.9.0, Nov 18 24

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.sqs.getQueue

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

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.

Using getQueue

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getQueue(args: GetQueueArgs, opts?: InvokeOptions): Promise<GetQueueResult>
function getQueueOutput(args: GetQueueOutputArgs, opts?: InvokeOptions): Output<GetQueueResult>

def get_queue(queue_url: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetQueueResult
def get_queue_output(queue_url: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetQueueResult]

func LookupQueue(ctx *Context, args *LookupQueueArgs, opts ...InvokeOption) (*LookupQueueResult, error)
func LookupQueueOutput(ctx *Context, args *LookupQueueOutputArgs, opts ...InvokeOption) LookupQueueResultOutput

> Note: This function is named LookupQueue in the Go SDK.

public static class GetQueue 
{
    public static Task<GetQueueResult> InvokeAsync(GetQueueArgs args, InvokeOptions? opts = null)
    public static Output<GetQueueResult> Invoke(GetQueueInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetQueueResult> getQueue(GetQueueArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:sqs:getQueue
  arguments:
    # arguments dictionary

The following arguments are supported:

QueueUrl string: Returns the URLs of the queues from the policy.

QueueUrl string: Returns the URLs of the queues from the policy.

queueUrl String: Returns the URLs of the queues from the policy.

queueUrl string: Returns the URLs of the queues from the policy.

queue_url str: Returns the URLs of the queues from the policy.

queueUrl String: Returns the URLs of the queues from the policy.

getQueue Result

The following output properties are available:

Arn string

Returns the Amazon Resource Name (ARN) of the queue. For example: arn:aws:sqs:us-east-2:123456789012:mystack-myqueue-15PG5C2FC1CW8 .

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.

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 (for example alias/aws/sqs), key ARN, or key ID. For more information, see the following:

Encryption at rest in the Developer Guide
CreateQueue in the API Reference
Request Parameters in the Key Management Service API Reference
The Key Management Service (KMS) section of the Security best practices for Key Management Service in the Key Management Service Developer Guide

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).

QueueUrl string

Returns the URLs of the queues from the policy.

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 received by a consumer of 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.Outputs.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.

Arn string

Returns the Amazon Resource Name (ARN) of the queue. For example: arn:aws:sqs:us-east-2:123456789012:mystack-myqueue-15PG5C2FC1CW8 .

ContentBasedDeduplication bool

DeduplicationScope string

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.

FifoThroughputLimit string

KmsDataKeyReusePeriodSeconds int

KmsMasterKeyId string

Encryption at rest in the Developer Guide
CreateQueue in the API Reference
Request Parameters in the Key Management Service API Reference
The Key Management Service (KMS) section of the Security best practices for Key Management Service in the Key Management Service Developer Guide

MaximumMessageSize int

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).

QueueUrl string

Returns the URLs of the queues from the policy.

ReceiveMessageWaitTimeSeconds int

RedriveAllowPolicy interface{}

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 received by a consumer of 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.

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

SqsManagedSseEnabled bool

Tags Tag

The tags that you attach to this queue. For more information, see Resource tag in the User Guide.

VisibilityTimeout int

arn String

Returns the Amazon Resource Name (ARN) of the queue. For example: arn:aws:sqs:us-east-2:123456789012:mystack-myqueue-15PG5C2FC1CW8 .

contentBasedDeduplication Boolean

deduplicationScope String

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.

fifoThroughputLimit String

kmsDataKeyReusePeriodSeconds Integer

kmsMasterKeyId String

Encryption at rest in the Developer Guide
CreateQueue in the API Reference
Request Parameters in the Key Management Service API Reference
The Key Management Service (KMS) section of the Security best practices for Key Management Service in the Key Management Service Developer Guide

maximumMessageSize Integer

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).

queueUrl String

Returns the URLs of the queues from the policy.

receiveMessageWaitTimeSeconds Integer

redriveAllowPolicy Object

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 received by a consumer of 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.

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

sqsManagedSseEnabled Boolean

tags List<Tag>

The tags that you attach to this queue. For more information, see Resource tag in the User Guide.

visibilityTimeout Integer

arn string

Returns the Amazon Resource Name (ARN) of the queue. For example: arn:aws:sqs:us-east-2:123456789012:mystack-myqueue-15PG5C2FC1CW8 .

contentBasedDeduplication boolean

deduplicationScope string

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.

fifoThroughputLimit string

kmsDataKeyReusePeriodSeconds number

kmsMasterKeyId string

Encryption at rest in the Developer Guide
CreateQueue in the API Reference
Request Parameters in the Key Management Service API Reference
The Key Management Service (KMS) section of the Security best practices for Key Management Service in the Key Management Service Developer Guide

maximumMessageSize number

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).

queueUrl string

Returns the URLs of the queues from the policy.

receiveMessageWaitTimeSeconds number

redriveAllowPolicy any

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 received by a consumer of 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.

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

sqsManagedSseEnabled boolean

tags Tag[]

The tags that you attach to this queue. For more information, see Resource tag in the User Guide.

visibilityTimeout number

arn str

Returns the Amazon Resource Name (ARN) of the queue. For example: arn:aws:sqs:us-east-2:123456789012:mystack-myqueue-15PG5C2FC1CW8 .

content_based_deduplication bool

deduplication_scope str

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_throughput_limit str

kms_data_key_reuse_period_seconds int

kms_master_key_id str

Encryption at rest in the Developer Guide
CreateQueue in the API Reference
Request Parameters in the Key Management Service API Reference
The Key Management Service (KMS) section of the Security best practices for Key Management Service in the Key Management Service Developer Guide

maximum_message_size int

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_url str

Returns the URLs of the queues from the policy.

receive_message_wait_time_seconds int

redrive_allow_policy Any

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 received by a consumer of 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.

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

sqs_managed_sse_enabled bool

tags Sequence[root_Tag]

The tags that you attach to this queue. For more information, see Resource tag in the User Guide.

visibility_timeout int

arn String

Returns the Amazon Resource Name (ARN) of the queue. For example: arn:aws:sqs:us-east-2:123456789012:mystack-myqueue-15PG5C2FC1CW8 .

contentBasedDeduplication Boolean

deduplicationScope String

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.

fifoThroughputLimit String

kmsDataKeyReusePeriodSeconds Number

kmsMasterKeyId String

Encryption at rest in the Developer Guide
CreateQueue in the API Reference
Request Parameters in the Key Management Service API Reference
The Key Management Service (KMS) section of the Security best practices for Key Management Service in the Key Management Service Developer Guide

maximumMessageSize Number

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).

queueUrl String

Returns the URLs of the queues from the policy.

receiveMessageWaitTimeSeconds Number

redriveAllowPolicy Any

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 received by a consumer of 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.

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

sqsManagedSseEnabled Boolean

tags List<Property Map>