aws-cdk-lib.aws_sqs.QueueAttributes

QueueAttributes Struct

Reference to a queue.

Source

aws-sqs/lib/queue-base.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sqs as sqs } from 'aws-cdk-lib';
const queueAttributes: sqs.QueueAttributes = {
  queueArn: 'queueArn',

  // the properties below are optional
  fifo: false,
  keyArn: 'keyArn',
  queueName: 'queueName',
  queueUrl: 'queueUrl',
};

Properties

fifobooleanfifoboolfifoBooleanFifoboolFifo*bool= if fifo is not specified, the pr…#

Whether this queue is an Amazon SQS FIFO queue. If false, this is a standard queue.

In case of a FIFO queue which is imported from a token, this value has to be explicitly set to true.

default

Default: if fifo is not specified, the property will be determined based on the queue name (not possible for FIFO queues imported from a token)

keyArnstringkey_arnstrkeyArnStringKeyArnstringKeyArn*string= None#

KMS encryption key, if this queue is server-side encrypted by a KMS key.

queueArnstringqueue_arnstrqueueArnStringQueueArnstringQueueArn*stringrequired#

The ARN of the queue.

queueNamestringqueue_namestrqueueNameStringQueueNamestringQueueName*string= if queue name is not specified, …#

The name of the queue.

default

Default: if queue name is not specified, the name will be derived from the queue ARN

queueUrlstringqueue_urlstrqueueUrlStringQueueUrlstringQueueUrl*string= 'https://sqs.<region-endpoint>/<…#

The URL of the queue.

default

Default: 'https://sqs.<region-endpoint>/<account-ID>/<queue-name>'