@Stability(value=Stable) @Internal public static final class QueueProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements QueueProps
QueuePropssoftware.amazon.jsii.JsiiObject.InitializationModeQueueProps.Builder, QueueProps.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
protected |
Jsii$Proxy(QueueProps.Builder builder)
Constructor that initializes the object based on literal property values passed by the
QueueProps.Builder. |
| Modifier and Type | Method and Description |
|---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(Object o) |
Boolean |
getContentBasedDeduplication()
Specifies whether to enable content-based deduplication.
|
Duration |
getDataKeyReuse()
The length of time that Amazon SQS reuses a data key before calling KMS again.
|
DeadLetterQueue |
getDeadLetterQueue()
Send messages to this queue if they were unsuccessfully dequeued a number of times.
|
DeduplicationScope |
getDeduplicationScope()
For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level.
|
Duration |
getDeliveryDelay()
The time in seconds that the delivery of all messages in the queue is delayed.
|
QueueEncryption |
getEncryption()
Whether the contents of the queue are encrypted, and by what type of key.
|
IKey |
getEncryptionMasterKey()
External KMS master key to use for queue encryption.
|
Boolean |
getFifo()
Whether this a first-in-first-out (FIFO) queue.
|
FifoThroughputLimit |
getFifoThroughputLimit()
For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group.
|
Number |
getMaxMessageSizeBytes()
The limit of how many bytes that a message can contain before Amazon SQS rejects it.
|
String |
getQueueName()
A name for the queue.
|
Duration |
getReceiveMessageWaitTime()
Default wait time for ReceiveMessage calls.
|
RemovalPolicy |
getRemovalPolicy()
Policy to apply when the queue is removed from the stack.
|
Duration |
getRetentionPeriod()
The number of seconds that Amazon SQS retains a message.
|
Duration |
getVisibilityTimeout()
Timeout of processing a single message.
|
int |
hashCode() |
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbuilderprotected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef - Reference to the JSII managed object.protected Jsii$Proxy(QueueProps.Builder builder)
QueueProps.Builder.public final Boolean getContentBasedDeduplication()
QueuePropsDuring 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.)
Default: false
getContentBasedDeduplication in interface QueuePropspublic final Duration getDataKeyReuse()
QueuePropsThe value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).
Default: Duration.minutes(5)
getDataKeyReuse in interface QueuePropspublic final DeadLetterQueue getDeadLetterQueue()
QueuePropsDefault: no dead-letter queue
getDeadLetterQueue in interface QueuePropspublic final DeduplicationScope getDeduplicationScope()
QueueProps(Only applies to FIFO queues.)
Default: DeduplicationScope.QUEUE
getDeduplicationScope in interface QueuePropspublic final Duration getDeliveryDelay()
QueuePropsYou can specify an integer value of 0 to 900 (15 minutes). The default value is 0.
Default: 0
getDeliveryDelay in interface QueuePropspublic final QueueEncryption getEncryption()
QueuePropsBe aware that encryption is not available in all regions, please see the docs for current availability details.
Default: Unencrypted
getEncryption in interface QueuePropspublic final IKey getEncryptionMasterKey()
QueueProps
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.
If the 'encryptionMasterKey' property is set, 'encryption' type will be implicitly set to "KMS".
Default: If encryption is set to KMS and not specified, a key will be created.
getEncryptionMasterKey in interface QueuePropspublic final Boolean getFifo()
QueuePropsDefault: false, unless queueName ends in '.fifo' or 'contentBasedDeduplication' is true.
getFifo in interface QueuePropspublic final FifoThroughputLimit getFifoThroughputLimit()
QueueProps(Only applies to FIFO queues.)
Default: FifoThroughputLimit.PER_QUEUE
getFifoThroughputLimit in interface QueuePropspublic final Number getMaxMessageSizeBytes()
QueuePropsYou can specify an integer value from 1024 bytes (1 KiB) to 262144 bytes (256 KiB). The default value is 262144 (256 KiB).
Default: 256KiB
getMaxMessageSizeBytes in interface QueuePropspublic final String getQueueName()
QueuePropsIf specified and this is a FIFO queue, must end in the string '.fifo'.
Default: CloudFormation-generated name
getQueueName in interface QueuePropspublic final Duration getReceiveMessageWaitTime()
QueuePropsDoes 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.
Default: 0
getReceiveMessageWaitTime in interface QueuePropspublic final RemovalPolicy getRemovalPolicy()
QueueProps
Even though queues are technically stateful, their contents are transient and it
is common to add and remove Queues while rearchitecting your application. The
default is therefore DESTROY. Change it to RETAIN if the messages are so
valuable that accidentally losing them would be unacceptable.
Default: RemovalPolicy.DESTROY
getRemovalPolicy in interface QueuePropspublic final Duration getRetentionPeriod()
QueuePropsYou can specify an integer value from 60 seconds (1 minute) to 1209600 seconds (14 days). The default value is 345600 seconds (4 days).
Default: Duration.days(4)
getRetentionPeriod in interface QueuePropspublic final Duration getVisibilityTimeout()
QueuePropsAfter 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.
Default: Duration.seconds(30)
getVisibilityTimeout in interface QueueProps@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson in interface software.amazon.jsii.JsiiSerializableCopyright © 2022. All rights reserved.