Package 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
@Stability(Stable) @Internal public static final class QueueProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements QueueProps
An implementation for QueueProps

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(QueueProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the QueueProps.Builder.

  • Method Details

    • getContentBasedDeduplication

      public final Boolean getContentBasedDeduplication()
      Description copied from interface: QueueProps
      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

      public final Duration getDataKeyReuse()
      Description copied from interface: QueueProps
      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

      public final DeadLetterQueue getDeadLetterQueue()
      Description copied from interface: QueueProps
      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

    • getDeduplicationScope

      public final DeduplicationScope getDeduplicationScope()
      Description copied from interface: QueueProps
      For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level.

      (Only applies to FIFO queues.)

      Default: DeduplicationScope.QUEUE

      Specified by:
      getDeduplicationScope in interface QueueProps

    • getDeliveryDelay

      public final Duration getDeliveryDelay()
      Description copied from interface: QueueProps
      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

      public final QueueEncryption getEncryption()
      Description copied from interface: QueueProps
      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

      public final IKey getEncryptionMasterKey()
      Description copied from interface: QueueProps
      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.

      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.

      Specified by:
      getEncryptionMasterKey in interface QueueProps

    • getFifo

      public final Boolean getFifo()
      Description copied from interface: QueueProps
      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

    • getFifoThroughputLimit

      public final FifoThroughputLimit getFifoThroughputLimit()
      Description copied from interface: QueueProps
      For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group.

      (Only applies to FIFO queues.)

      Default: FifoThroughputLimit.PER_QUEUE

      Specified by:
      getFifoThroughputLimit in interface QueueProps

    • getMaxMessageSizeBytes

      public final Number getMaxMessageSizeBytes()
      Description copied from interface: QueueProps
      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

      public final String getQueueName()
      Description copied from interface: QueueProps
      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

      public final Duration getReceiveMessageWaitTime()
      Description copied from interface: QueueProps
      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

    • getRemovalPolicy

      public final RemovalPolicy getRemovalPolicy()
      Description copied from interface: QueueProps
      Policy to apply when the queue is removed from the stack.

      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

      Specified by:
      getRemovalPolicy in interface QueueProps

    • getRetentionPeriod

      public final Duration getRetentionPeriod()
      Description copied from interface: QueueProps
      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

      public final Duration getVisibilityTimeout()
      Description copied from interface: QueueProps
      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

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object