GetQueueResult

data class GetQueueResult(val arn: String? = null, val contentBasedDeduplication: Boolean? = null, val deduplicationScope: String? = null, val delaySeconds: Int? = null, val fifoThroughputLimit: String? = null, val kmsDataKeyReusePeriodSeconds: Int? = null, val kmsMasterKeyId: String? = null, val maximumMessageSize: Int? = null, val messageRetentionPeriod: Int? = null, val queueUrl: String? = null, val receiveMessageWaitTimeSeconds: Int? = null, val redriveAllowPolicy: Any? = null, val redrivePolicy: Any? = null, val sqsManagedSseEnabled: Boolean? = null, val tags: List<Tag>? = null, val visibilityTimeout: Int? = null)

Constructors

Link copied to clipboard
constructor(arn: String? = null, contentBasedDeduplication: Boolean? = null, deduplicationScope: String? = null, delaySeconds: Int? = null, fifoThroughputLimit: String? = null, kmsDataKeyReusePeriodSeconds: Int? = null, kmsMasterKeyId: String? = null, maximumMessageSize: Int? = null, messageRetentionPeriod: Int? = null, queueUrl: String? = null, receiveMessageWaitTimeSeconds: Int? = null, redriveAllowPolicy: Any? = null, redrivePolicy: Any? = null, sqsManagedSseEnabled: Boolean? = null, tags: List<Tag>? = null, visibilityTimeout: Int? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String? = null

Returns the Amazon Resource Name (ARN) of the queue. For example: arn:aws:sqs:us-east-2:123456789012:mystack-myqueue-15PG5C2FC1CW8 .

Link copied to clipboard

For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the `ContentBasedDeduplication` attribute for the `CreateQueue` action in the API Reference.

Link copied to clipboard

For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are `messageGroup` and `queue`. To enable high throughput for a FIFO queue, set this attribute to `messageGroup` and set the `FifoThroughputLimit` attribute to `perMessageGroupId`. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see High throughput for FIFO queues and Quotas related to messages in the Developer Guide.

Link copied to clipboard
val delaySeconds: Int? = null

The time in seconds for which 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`.

Link copied to clipboard

For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are `perQueue` and `perMessageGroupId`. To enable high throughput for a FIFO queue, set this attribute to `perMessageGroupId` and set the `DeduplicationScope` attribute to `messageGroup`. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see High throughput for FIFO queues and Quotas related to messages in the Developer Guide.

Link copied to clipboard

The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages 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). A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see Encryption at rest in the Developer Guide.

Link copied to clipboard
val kmsMasterKeyId: String? = null

The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. `alias/aws/sqs`), key ARN, or key ID. For more information, see the following:

Link copied to clipboard
val maximumMessageSize: Int? = null

The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from `1,024` bytes (1 KiB) to `262,144` bytes (256 KiB). The default value is `262,144` (256 KiB).

Link copied to clipboard

The number of seconds that SQS retains a message. You can specify an integer value from `60` seconds (1 minute) to `1,209,600` seconds (14 days). The default value is `345,600` seconds (4 days).

Link copied to clipboard
val queueUrl: String? = null

Returns the URLs of the queues from the policy.

Link copied to clipboard

Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see Consuming messages using long polling in the Developer Guide.

Link copied to clipboard
val redriveAllowPolicy: Any? = null

The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:

Link copied to clipboard
val redrivePolicy: Any? = null

The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows:

Link copied to clipboard

Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS). When `SqsManagedSseEnabled` is not defined, `SSE-SQS` encryption is enabled by default.

Link copied to clipboard
val tags: List<Tag>? = null

The tags that you attach to this queue. For more information, see Resource tag in the User Guide.

Link copied to clipboard
val visibilityTimeout: Int? = null

The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds. For more information about SQS queue visibility timeouts, see Visibility timeout in the Developer Guide.