QueueAttributes

class aws_cdk.aws_sqs.QueueAttributes(*, queue_arn, fifo=None, key_arn=None, queue_name=None, queue_url=None)

Bases: object

Reference to a queue.

Parameters:

  • queue_arn (str) – The ARN of the queue.

  • fifo (Optional[bool]) – 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: - if fifo is not specified, the property will be determined based on the queue name (not possible for FIFO queues imported from a token)

  • key_arn (Optional[str]) – KMS encryption key, if this queue is server-side encrypted by a KMS key. Default: - None

  • queue_name (Optional[str]) – The name of the queue. Default: if queue name is not specified, the name will be derived from the queue ARN

  • queue_url (Optional[str]) – The URL of the queue. Default: - ‘https://sqs.//’

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_sqs as sqs

queue_attributes = sqs.QueueAttributes(
    queue_arn="queueArn",

    # the properties below are optional
    fifo=False,
    key_arn="keyArn",
    queue_name="queueName",
    queue_url="queueUrl"
)

Attributes

fifo

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:

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

key_arn

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

Default:

  • None

queue_arn

The ARN of the queue.

queue_name

The name of the queue.

Default:

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

queue_url

The URL of the queue.

Default:
See:

https://docs.aws.amazon.com/sdk-for-net/v2/developer-guide/QueueURL.html