software.amazon.awscdk.services.sqs

Class QueueProps.Builder

java.lang.Object

software.amazon.awscdk.services.sqs.QueueProps.Builder

Enclosing interface:

QueueProps

public static final class QueueProps.Builder
extends Object

A builder for QueueProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
QueueProps	build() Builds the configured instance.
QueueProps.Builder	withContentBasedDeduplication(Boolean value) Sets the value of ContentBasedDeduplication
QueueProps.Builder	withDataKeyReuseSec(Number value) Sets the value of DataKeyReuseSec
QueueProps.Builder	withDeadLetterQueue(DeadLetterQueue value) Sets the value of DeadLetterQueue
QueueProps.Builder	withDeliveryDelaySec(Number value) Sets the value of DeliveryDelaySec
QueueProps.Builder	withEncryption(QueueEncryption value) Sets the value of Encryption
QueueProps.Builder	withEncryptionMasterKey(software.amazon.awscdk.services.kms.IEncryptionKey value) Sets the value of EncryptionMasterKey
QueueProps.Builder	withFifo(Boolean value) Sets the value of Fifo
QueueProps.Builder	withMaxMessageSizeBytes(Number value) Sets the value of MaxMessageSizeBytes
QueueProps.Builder	withQueueName(String value) Sets the value of QueueName
QueueProps.Builder	withReceiveMessageWaitTimeSec(Number value) Sets the value of ReceiveMessageWaitTimeSec
QueueProps.Builder	withRetentionPeriodSec(Number value) Sets the value of RetentionPeriodSec
QueueProps.Builder	withVisibilityTimeoutSec(Number value) Sets the value of VisibilityTimeoutSec

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

withContentBasedDeduplication

public QueueProps.Builder withContentBasedDeduplication(@Nullable
                                                        Boolean value)

Sets the value of ContentBasedDeduplication

Parameters:

value - Specifies whether to enable content-based deduplication. During the deduplication interval (5 minutes), Amazon SQS treats messages that are sent with identical content (excluding attributes) as duplicates and delivers only one copy of the message. If you don't enable content-based deduplication and you want to deduplicate messages, provide an explicit deduplication ID in your SendMessage() call. (Only applies to FIFO queues.)

Returns:

this

withDataKeyReuseSec

public QueueProps.Builder withDataKeyReuseSec(@Nullable
                                              Number value)

Sets the value of DataKeyReuseSec

Parameters:

value - The length of time that Amazon SQS reuses a data key 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).

Returns:

this

withDeadLetterQueue

public QueueProps.Builder withDeadLetterQueue(@Nullable
                                              DeadLetterQueue value)

Sets the value of DeadLetterQueue

Parameters:

value - Send messages to this queue if they were unsuccessfully dequeued a number of times.

Returns:

this

withDeliveryDelaySec

public QueueProps.Builder withDeliveryDelaySec(@Nullable
                                               Number value)

Sets the value of DeliveryDelaySec

Parameters:

value - The time in seconds that 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.

Returns:

this

withEncryption

public QueueProps.Builder withEncryption(@Nullable
                                         QueueEncryption value)

Sets the value of Encryption

Parameters:

value - Whether the contents of the queue are encrypted, and by what type of key. Be aware that encryption is not available in all regions, please see the docs for current availability details.

Returns:

this

withEncryptionMasterKey

public QueueProps.Builder withEncryptionMasterKey(@Nullable
                                                  software.amazon.awscdk.services.kms.IEncryptionKey value)

Sets the value of EncryptionMasterKey

Parameters:

value - External KMS master key to use for queue encryption. Individual messages will be encrypted using data keys. The data keys in turn will be encrypted using this key, and reused for a maximum of `dataKeyReuseSecs` seconds. The 'encryption' property must be either not specified or set to "Kms". An error will be emitted if encryption is set to "Unencrypted" or "KmsManaged".

Returns:

this

withFifo

public QueueProps.Builder withFifo(@Nullable
                                   Boolean value)

Sets the value of Fifo

Parameters:

value - Whether this a first-in-first-out (FIFO) queue.

Returns:

this

withMaxMessageSizeBytes

public QueueProps.Builder withMaxMessageSizeBytes(@Nullable
                                                  Number value)

Sets the value of MaxMessageSizeBytes

Parameters:

value - The limit of how many bytes that a message can contain before Amazon SQS rejects it. You can specify an integer value from 1024 bytes (1 KiB) to 262144 bytes (256 KiB). The default value is 262144 (256 KiB).

Returns:

this

withQueueName

public QueueProps.Builder withQueueName(@Nullable
                                        String value)

Sets the value of QueueName

Parameters:

value - A name for the queue. If specified and this is a FIFO queue, must end in the string '.fifo'.

Returns:

this

withReceiveMessageWaitTimeSec

public QueueProps.Builder withReceiveMessageWaitTimeSec(@Nullable
                                                        Number value)

Sets the value of ReceiveMessageWaitTimeSec

Parameters:

value - Default wait time for ReceiveMessage calls. Does not wait if set to 0, otherwise waits this amount of seconds by default for messages to arrive. For more information, see Amazon SQS Long Poll.

Returns:

this

withRetentionPeriodSec

public QueueProps.Builder withRetentionPeriodSec(@Nullable
                                                 Number value)

Sets the value of RetentionPeriodSec

Parameters:

value - The number of seconds that Amazon SQS retains a message. You can specify an integer value from 60 seconds (1 minute) to 1209600 seconds (14 days). The default value is 345600 seconds (4 days).

Returns:

this

withVisibilityTimeoutSec

public QueueProps.Builder withVisibilityTimeoutSec(@Nullable
                                                   Number value)

Sets the value of VisibilityTimeoutSec

Parameters:

value - Timeout of processing a single message. After dequeuing, the processor has this much time to handle the message and delete it from the queue before it becomes visible again for dequeueing by another processor. Values must be from 0 to 43200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds.

Returns:

this

build

public QueueProps build()

Builds the configured instance.

Returns:

a new instance of QueueProps

Throws:

NullPointerException - if any required attribute was not provided