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.
Number	getDataKeyReuseSec() 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.
Number	getDeliveryDelaySec() 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.IEncryptionKey	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.
Number	getReceiveMessageWaitTimeSec() Default wait time for ReceiveMessage calls.
Number	getRetentionPeriodSec() The number of seconds that Amazon SQS retains a message.
Number	getVisibilityTimeoutSec() Timeout of processing a single message.
void	setContentBasedDeduplication(Boolean value) Specifies whether to enable content-based deduplication.
void	setDataKeyReuseSec(Number value) The length of time that Amazon SQS reuses a data key before calling KMS again.
void	setDeadLetterQueue(DeadLetterQueue value) Send messages to this queue if they were unsuccessfully dequeued a number of times.
void	setDeliveryDelaySec(Number value) The time in seconds that the delivery of all messages in the queue is delayed.
void	setEncryption(QueueEncryption value) Whether the contents of the queue are encrypted, and by what type of key.
void	setEncryptionMasterKey(software.amazon.awscdk.services.kms.IEncryptionKey value) External KMS master key to use for queue encryption.
void	setFifo(Boolean value) Whether this a first-in-first-out (FIFO) queue.
void	setMaxMessageSizeBytes(Number value) The limit of how many bytes that a message can contain before Amazon SQS rejects it.
void	setQueueName(String value) A name for the queue.
void	setReceiveMessageWaitTimeSec(Number value) Default wait time for ReceiveMessage calls.
void	setRetentionPeriodSec(Number value) The number of seconds that Amazon SQS retains a message.
void	setVisibilityTimeoutSec(Number value) 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

Constructor Detail

Jsii$Proxy

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

Method Detail

getContentBasedDeduplication

@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.)

Specified by:

getContentBasedDeduplication in interface QueueProps

setContentBasedDeduplication

public void setContentBasedDeduplication(@Nullable
                                         Boolean 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.)

Specified by:

setContentBasedDeduplication in interface QueueProps

getDataKeyReuseSec

@Nullable
public Number getDataKeyReuseSec()

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).

Specified by:

getDataKeyReuseSec in interface QueueProps

setDataKeyReuseSec

public void setDataKeyReuseSec(@Nullable
                               Number 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).

Specified by:

setDataKeyReuseSec in interface QueueProps

getDeadLetterQueue

@Nullable
public DeadLetterQueue getDeadLetterQueue()

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

Specified by:

getDeadLetterQueue in interface QueueProps

setDeadLetterQueue

public void setDeadLetterQueue(@Nullable
                               DeadLetterQueue value)

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

Specified by:

setDeadLetterQueue in interface QueueProps

getDeliveryDelaySec

@Nullable
public Number getDeliveryDelaySec()

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.

Specified by:

getDeliveryDelaySec in interface QueueProps

setDeliveryDelaySec

public void setDeliveryDelaySec(@Nullable
                                Number 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.

Specified by:

setDeliveryDelaySec in interface QueueProps

getEncryption

@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.

Specified by:

getEncryption in interface QueueProps

setEncryption

public void setEncryption(@Nullable
                          QueueEncryption 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.

Specified by:

setEncryption in interface QueueProps

getEncryptionMasterKey

@Nullable
public software.amazon.awscdk.services.kms.IEncryptionKey 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".

Specified by:

getEncryptionMasterKey in interface QueueProps

setEncryptionMasterKey

public void setEncryptionMasterKey(@Nullable
                                   software.amazon.awscdk.services.kms.IEncryptionKey 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".

Specified by:

setEncryptionMasterKey in interface QueueProps

getFifo

@Nullable
public Boolean getFifo()

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

Specified by:

getFifo in interface QueueProps

setFifo

public void setFifo(@Nullable
                    Boolean value)

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

Specified by:

setFifo in interface QueueProps

getMaxMessageSizeBytes

@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).

Specified by:

getMaxMessageSizeBytes in interface QueueProps

setMaxMessageSizeBytes

public void setMaxMessageSizeBytes(@Nullable
                                   Number 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).

Specified by:

setMaxMessageSizeBytes in interface QueueProps

getQueueName

@Nullable
public String getQueueName()

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

Specified by:

getQueueName in interface QueueProps

setQueueName

public void setQueueName(@Nullable
                         String value)

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

Specified by:

setQueueName in interface QueueProps

getReceiveMessageWaitTimeSec

@Nullable
public Number getReceiveMessageWaitTimeSec()

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.

Specified by:

getReceiveMessageWaitTimeSec in interface QueueProps

setReceiveMessageWaitTimeSec

public void setReceiveMessageWaitTimeSec(@Nullable
                                         Number 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.

Specified by:

setReceiveMessageWaitTimeSec in interface QueueProps

getRetentionPeriodSec

@Nullable
public Number getRetentionPeriodSec()

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).

Specified by:

getRetentionPeriodSec in interface QueueProps

setRetentionPeriodSec

public void setRetentionPeriodSec(@Nullable
                                  Number 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).

Specified by:

setRetentionPeriodSec in interface QueueProps

getVisibilityTimeoutSec

@Nullable
public Number getVisibilityTimeoutSec()

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.

Specified by:

getVisibilityTimeoutSec in interface QueueProps

setVisibilityTimeoutSec

public void setVisibilityTimeoutSec(@Nullable
                                    Number 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.

Specified by:

setVisibilityTimeoutSec in interface QueueProps