QueueProps (software.amazon.awscdk:sqs 0.25.2 API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: QueueProps.Jsii$Proxy

@Generated(value="jsii-pacmak/0.7.15 (build e429c41)",
           date="2019-03-07T22:16:52.945Z")
public interface QueueProps
extends software.amazon.jsii.JsiiSerializable

Properties for creating a new Queue

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`QueueProps.Builder` A builder for `QueueProps`
`static class`	`QueueProps.Jsii$Proxy` A proxy class which represents a concrete javascript instance of this type.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static QueueProps.Builder`	`builder()`
`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.

- Method Detail
  - getContentBasedDeduplication
```
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.)
  - setContentBasedDeduplication
```
void setContentBasedDeduplication(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.)
  - getDataKeyReuseSec
```
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).
  - setDataKeyReuseSec
```
void setDataKeyReuseSec(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).
  - getDeadLetterQueue
```
DeadLetterQueue getDeadLetterQueue()
```
    Send messages to this queue if they were unsuccessfully dequeued a number of times.
  - setDeadLetterQueue
```
void setDeadLetterQueue(DeadLetterQueue value)
```
    Send messages to this queue if they were unsuccessfully dequeued a number of times.
  - getDeliveryDelaySec
```
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.
  - setDeliveryDelaySec
```
void setDeliveryDelaySec(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.
  - getEncryption
```
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.
  - setEncryption
```
void setEncryption(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.
  - getEncryptionMasterKey
```
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".
  - setEncryptionMasterKey
```
void setEncryptionMasterKey(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".
  - getFifo
```
Boolean getFifo()
```
    Whether this a first-in-first-out (FIFO) queue.
  - setFifo
```
void setFifo(Boolean value)
```
    Whether this a first-in-first-out (FIFO) queue.
  - getMaxMessageSizeBytes
```
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).
  - setMaxMessageSizeBytes
```
void setMaxMessageSizeBytes(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).
  - getQueueName
```
String getQueueName()
```
    A name for the queue. If specified and this is a FIFO queue, must end in the string '.fifo'.
  - setQueueName
```
void setQueueName(String value)
```
    A name for the queue. If specified and this is a FIFO queue, must end in the string '.fifo'.
  - getReceiveMessageWaitTimeSec
```
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.
  - setReceiveMessageWaitTimeSec
```
void setReceiveMessageWaitTimeSec(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.
  - getRetentionPeriodSec
```
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).
  - setRetentionPeriodSec
```
void setRetentionPeriodSec(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).
  - getVisibilityTimeoutSec
```
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.
  - setVisibilityTimeoutSec
```
void setVisibilityTimeoutSec(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.
  - builder
```
static QueueProps.Builder builder()
```
    Returns:
    
    a QueueProps.Builder of QueueProps

Interface QueueProps

Nested Class Summary

Method Summary

Method Detail

getContentBasedDeduplication

setContentBasedDeduplication

getDataKeyReuseSec

setDataKeyReuseSec

getDeadLetterQueue

setDeadLetterQueue

getDeliveryDelaySec

setDeliveryDelaySec

getEncryption

setEncryption

getEncryptionMasterKey

setEncryptionMasterKey

getFifo

setFifo

getMaxMessageSizeBytes

setMaxMessageSizeBytes

getQueueName

setQueueName

getReceiveMessageWaitTimeSec

setReceiveMessageWaitTimeSec

getRetentionPeriodSec

setRetentionPeriodSec

getVisibilityTimeoutSec

setVisibilityTimeoutSec

builder