software.amazon.awscdk.services.sqs

Class QueueProps.Builder

java.lang.Object

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

Enclosing interface:

QueueProps

@Stability(value=Stable)
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	contentBasedDeduplication(Boolean contentBasedDeduplication) Sets the value of ContentBasedDeduplication
QueueProps.Builder	dataKeyReuse(software.amazon.awscdk.core.Duration dataKeyReuse) Sets the value of DataKeyReuse
QueueProps.Builder	deadLetterQueue(DeadLetterQueue deadLetterQueue) Sets the value of DeadLetterQueue
QueueProps.Builder	deliveryDelay(software.amazon.awscdk.core.Duration deliveryDelay) Sets the value of DeliveryDelay
QueueProps.Builder	encryption(QueueEncryption encryption) Sets the value of Encryption
QueueProps.Builder	encryptionMasterKey(software.amazon.awscdk.services.kms.IKey encryptionMasterKey) Sets the value of EncryptionMasterKey
QueueProps.Builder	fifo(Boolean fifo) Sets the value of Fifo
QueueProps.Builder	maxMessageSizeBytes(Number maxMessageSizeBytes) Sets the value of MaxMessageSizeBytes
QueueProps.Builder	queueName(String queueName) Sets the value of QueueName
QueueProps.Builder	receiveMessageWaitTime(software.amazon.awscdk.core.Duration receiveMessageWaitTime) Sets the value of ReceiveMessageWaitTime
QueueProps.Builder	retentionPeriod(software.amazon.awscdk.core.Duration retentionPeriod) Sets the value of RetentionPeriod
QueueProps.Builder	visibilityTimeout(software.amazon.awscdk.core.Duration visibilityTimeout) Sets the value of VisibilityTimeout

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

contentBasedDeduplication

@Stability(value=Stable)
public QueueProps.Builder contentBasedDeduplication(Boolean contentBasedDeduplication)

Sets the value of ContentBasedDeduplication

Parameters:

contentBasedDeduplication - Specifies whether to enable content-based deduplication.

Returns:

this

dataKeyReuse

@Stability(value=Stable)
public QueueProps.Builder dataKeyReuse(software.amazon.awscdk.core.Duration dataKeyReuse)

Sets the value of DataKeyReuse

Parameters:

dataKeyReuse - The length of time that Amazon SQS reuses a data key before calling KMS again.

Returns:

this

deadLetterQueue

@Stability(value=Stable)
public QueueProps.Builder deadLetterQueue(DeadLetterQueue deadLetterQueue)

Sets the value of DeadLetterQueue

Parameters:

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

Returns:

this

deliveryDelay

@Stability(value=Stable)
public QueueProps.Builder deliveryDelay(software.amazon.awscdk.core.Duration deliveryDelay)

Sets the value of DeliveryDelay

Parameters:

deliveryDelay - The time in seconds that the delivery of all messages in the queue is delayed.

Returns:

this

encryption

@Stability(value=Stable)
public QueueProps.Builder encryption(QueueEncryption encryption)

Sets the value of Encryption

Parameters:

encryption - Whether the contents of the queue are encrypted, and by what type of key.

Returns:

this

encryptionMasterKey

@Stability(value=Stable)
public QueueProps.Builder encryptionMasterKey(software.amazon.awscdk.services.kms.IKey encryptionMasterKey)

Sets the value of EncryptionMasterKey

Parameters:

encryptionMasterKey - External KMS master key to use for queue encryption.

Returns:

this

fifo

@Stability(value=Stable)
public QueueProps.Builder fifo(Boolean fifo)

Sets the value of Fifo

Parameters:

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

Returns:

this

maxMessageSizeBytes

@Stability(value=Stable)
public QueueProps.Builder maxMessageSizeBytes(Number maxMessageSizeBytes)

Sets the value of MaxMessageSizeBytes

Parameters:

maxMessageSizeBytes - The limit of how many bytes that a message can contain before Amazon SQS rejects it.

Returns:

this

queueName

@Stability(value=Stable)
public QueueProps.Builder queueName(String queueName)

Sets the value of QueueName

Parameters:

queueName - A name for the queue.

Returns:

this

receiveMessageWaitTime

@Stability(value=Stable)
public QueueProps.Builder receiveMessageWaitTime(software.amazon.awscdk.core.Duration receiveMessageWaitTime)

Sets the value of ReceiveMessageWaitTime

Parameters:

receiveMessageWaitTime - Default wait time for ReceiveMessage calls.

Returns:

this

retentionPeriod

@Stability(value=Stable)
public QueueProps.Builder retentionPeriod(software.amazon.awscdk.core.Duration retentionPeriod)

Sets the value of RetentionPeriod

Parameters:

retentionPeriod - The number of seconds that Amazon SQS retains a message.

Returns:

this

visibilityTimeout

@Stability(value=Stable)
public QueueProps.Builder visibilityTimeout(software.amazon.awscdk.core.Duration visibilityTimeout)

Sets the value of VisibilityTimeout

Parameters:

visibilityTimeout - Timeout of processing a single message.

Returns:

this

build

@Stability(value=Stable)
public QueueProps build()

Builds the configured instance.

Returns:

a new instance of QueueProps

Throws:

NullPointerException - if any required attribute was not provided