Package software.amazon.awscdk.services.sqs

Interface QueueAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

QueueAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:09.946Z")
@Stability(Stable)
public interface QueueAttributes
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.sqs.*;
 QueueAttributes queueAttributes = QueueAttributes.builder()
         .queueArn("queueArn")
         // the properties below are optional
         .fifo(false)
         .keyArn("keyArn")
         .queueName("queueName")
         .queueUrl("queueUrl")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	QueueAttributes.Builder	A builder for QueueAttributes
static final class	QueueAttributes.Jsii$Proxy	An implementation for QueueAttributes

Method Summary

Modifier and Type	Method	Description
static QueueAttributes.Builder	builder()
default Boolean	getFifo()	Whether this queue is an Amazon SQS FIFO queue.
default String	getKeyArn()	KMS encryption key, if this queue is server-side encrypted by a KMS key.
String	getQueueArn()	The ARN of the queue.
default String	getQueueName()	The name of the queue.
default String	getQueueUrl()	The URL of the queue.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getQueueArn

@Stability(Stable)
@NotNull
String getQueueArn()

The ARN of the queue.

getFifo

@Stability(Stable)
@Nullable
default Boolean getFifo()

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)

getKeyArn

@Stability(Stable)
@Nullable
default String getKeyArn()

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

Default: - None

getQueueName

@Stability(Stable)
@Nullable
default String getQueueName()

The name of the queue.

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

getQueueUrl

@Stability(Stable)
@Nullable
default String getQueueUrl()

The URL of the queue.

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

See Also:

• https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html#sqs-general-identifiers

builder

@Stability(Stable)
static QueueAttributes.Builder builder()

Returns:

a QueueAttributes.Builder of QueueAttributes