software.amazon.awscdk.services.sqs

Class QueueProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.sqs.QueueProps.Jsii$Proxy

All Implemented Interfaces:

QueueProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

QueueProps

public static final class QueueProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements QueueProps

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.sqs.QueueProps

QueueProps.Builder, QueueProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObject.InitializationMode mode)

Method Summary

Modifier and Type	Method and Description
Boolean	getContentBasedDeduplication() Specifies whether to enable content-based deduplication.
software.amazon.awscdk.core.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.
software.amazon.awscdk.core.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.
software.amazon.awscdk.services.kms.IKey	getEncryptionMasterKey() External KMS master key to use for queue encryption.
Boolean	getFifo() Whether this a first-in-first-out (FIFO) queue.
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.
software.amazon.awscdk.core.Duration	getReceiveMessageWaitTime() Default wait time for ReceiveMessage calls.
software.amazon.awscdk.core.Duration	getRetentionPeriod() The number of seconds that Amazon SQS retains a message.
software.amazon.awscdk.core.Duration	getVisibilityTimeout() Timeout of processing a single message.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.services.sqs.QueueProps

builder

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObject.InitializationMode mode)

Method Detail

getContentBasedDeduplication

@Stability(value=Stable)
 @Nullable
public Boolean getContentBasedDeduplication()

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.) Default: false

Specified by:

getContentBasedDeduplication in interface QueueProps

getDataKeyReuse

@Stability(value=Stable)
 @Nullable
public software.amazon.awscdk.core.Duration getDataKeyReuse()

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). Default: Duration.minutes(5)

Specified by:

getDataKeyReuse in interface QueueProps

getDeadLetterQueue

@Stability(value=Stable)
 @Nullable
public DeadLetterQueue getDeadLetterQueue()

Send messages to this queue if they were unsuccessfully dequeued a number of times. Default: no dead-letter queue

Specified by:

getDeadLetterQueue in interface QueueProps

getDeliveryDelay

@Stability(value=Stable)
 @Nullable
public software.amazon.awscdk.core.Duration getDeliveryDelay()

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. Default: 0

Specified by:

getDeliveryDelay in interface QueueProps

getEncryption

@Stability(value=Stable)
 @Nullable
public QueueEncryption getEncryption()

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. Default: Unencrypted

Specified by:

getEncryption in interface QueueProps

getEncryptionMasterKey

@Stability(value=Stable)
 @Nullable
public software.amazon.awscdk.services.kms.IKey getEncryptionMasterKey()

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". Default: If encryption is set to KMS and not specified, a key will be created.

Specified by:

getEncryptionMasterKey in interface QueueProps

getFifo

@Stability(value=Stable)
 @Nullable
public Boolean getFifo()

Whether this a first-in-first-out (FIFO) queue. Default: false, unless queueName ends in '.fifo' or 'contentBasedDeduplication' is true.

Specified by:

getFifo in interface QueueProps

getMaxMessageSizeBytes

@Stability(value=Stable)
 @Nullable
public Number getMaxMessageSizeBytes()

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). Default: 256KiB

Specified by:

getMaxMessageSizeBytes in interface QueueProps

getQueueName

@Stability(value=Stable)
 @Nullable
public String getQueueName()

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

Specified by:

getQueueName in interface QueueProps

getReceiveMessageWaitTime

@Stability(value=Stable)
 @Nullable
public software.amazon.awscdk.core.Duration getReceiveMessageWaitTime()

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. Default: 0

Specified by:

getReceiveMessageWaitTime in interface QueueProps

getRetentionPeriod

@Stability(value=Stable)
 @Nullable
public software.amazon.awscdk.core.Duration getRetentionPeriod()

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). Default: Duration.days(4)

Specified by:

getRetentionPeriod in interface QueueProps

getVisibilityTimeout

@Stability(value=Stable)
 @Nullable
public software.amazon.awscdk.core.Duration getVisibilityTimeout()

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. Default: Duration.seconds(30)

Specified by:

getVisibilityTimeout in interface QueueProps