interface QueueAttributes

Language	Type name
.NET	`Amazon.CDK.AWS.SQS.QueueAttributes`
Java	`software.amazon.awscdk.services.sqs.QueueAttributes`
Python	`aws_cdk.aws_sqs.QueueAttributes`
TypeScript (source)	`@aws-cdk/aws-sqs` » `QueueAttributes`

Reference to a queue.

Example

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

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

Properties

Name	Type	Description
queueArn	`string`	The ARN of the queue.
fifo?	`boolean`	Whether this queue is an Amazon SQS FIFO queue. If false, this is a standard queue.
keyArn?	`string`	KMS encryption key, if this queue is server-side encrypted by a KMS key.
queueName?	`string`	The name of the queue.
queueUrl?	`string`	The URL of the queue.

queueArn

Type: string

The ARN of the queue.

fifo?

Type: boolean (optional, 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))

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.

keyArn?

Type: string (optional, default: None)

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

queueName?

Type: string (optional, default: if queue name is not specified, the name will be derived from the queue ARN)

The name of the queue.

queueUrl?

Type: string (optional, default: 'https://sqs.<region-endpoint>/<account-ID>/<queue-name>')

The URL of the queue.