QueueState class
Input properties used for looking up and filtering Queue resources.
Constructors
-
QueueState({Input<
String?> ? arn, Input<bool?> ? contentBasedDeduplication, Input<String?> ? deduplicationScope, Input<int?> ? delaySeconds, Input<bool?> ? fifoQueue, Input<String?> ? fifoThroughputLimit, Input<int?> ? kmsDataKeyReusePeriodSeconds, Input<String?> ? kmsMasterKeyId, Input<int?> ? maxMessageSize, Input<int?> ? messageRetentionSeconds, Input<String?> ? name, Input<String?> ? namePrefix, Input<String?> ? policy, Input<int?> ? receiveWaitTimeSeconds, Input<String?> ? redriveAllowPolicy, Input<String?> ? redrivePolicy, Input<String?> ? region, Input<bool?> ? sqsManagedSseEnabled, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>String?> ? url, Input<int?> ? visibilityTimeoutSeconds}) -
Creates a new QueueState.
arnARN of the SQS queue.contentBasedDeduplicationEnables content-based deduplication for FIFO queues. For more information, see the related documentation.deduplicationScopeSpecifies whether message deduplication occurs at the message group or queue level. Valid values aremessageGroupandqueue(default).delaySecondsTime in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 seconds.fifoQueueBoolean designating a FIFO queue. If not set, it defaults tofalsemaking it standard.fifoThroughputLimitSpecifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values areperQueue(default) andperMessageGroupId.kmsDataKeyReusePeriodSecondsLength of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).kmsMasterKeyIdID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.maxMessageSizeLimit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 1048576 bytes (1024 KiB). The default for this attribute is 262144 (256 KiB).messageRetentionSecondsNumber of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).nameName of the queue. Queue names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 80 characters long. For a FIFO (first-in-first-out) queue, the name must end with the.fifosuffix. If omitted, the provider will assign a random, unique name. Conflicts withnamePrefix.namePrefixCreates a unique name beginning with the specified prefix. Conflicts withname.policyJSON policy for the SQS queue. For more information about building AWS IAM policy documents see the AWS IAM Policy Document Guide. The provider will only perform drift detection of its value when present in a configuration. It is preferred to use theaws.sqs.QueuePolicyresource instead.receiveWaitTimeSecondsTime for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default for this attribute is 0, meaning that the call will return immediately.redriveAllowPolicyJSON policy to set up the Dead Letter Queue redrive permission, see AWS docs. The provider will only perform drift detection of its value when present in a configuration. It is preferred to use theaws.sqs.RedriveAllowPolicyresource instead.redrivePolicyJSON policy to set up the Dead Letter Queue, see AWS docs. The provider will only perform drift detection of its value when present in a configuration. It is preferred to use theaws.sqs.RedrivePolicyresource instead. Note: when specifyingmaxReceiveCount, you must specify it as an integer (5), and not a string ("5").regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.sqsManagedSseEnabledBoolean to enable server-side encryption (SSE) of message content with SQS-owned encryption keys. See Encryption at rest. The provider will only perform drift detection of its value when present in a configuration.tagsMap of tags to assign to the queue. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.urlSame asid: The URL for the created Amazon SQS queue.visibilityTimeoutSecondsVisibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see AWS docs.const -
QueueState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
arn
→ Input<
String?> ? -
ARN of the SQS queue.
final
-
contentBasedDeduplication
→ Input<
bool?> ? -
Enables content-based deduplication for FIFO queues. For more information, see the related documentation.
final
-
deduplicationScope
→ Input<
String?> ? -
Specifies whether message deduplication occurs at the message group or queue level. Valid values are
messageGroupandqueue(default).final -
delaySeconds
→ Input<
int?> ? -
Time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 seconds.
final
-
fifoQueue
→ Input<
bool?> ? -
Boolean designating a FIFO queue. If not set, it defaults to
falsemaking it standard.final -
fifoThroughputLimit
→ Input<
String?> ? -
Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are
perQueue(default) andperMessageGroupId.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
kmsDataKeyReusePeriodSeconds
→ Input<
int?> ? -
Length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes).
final
-
kmsMasterKeyId
→ Input<
String?> ? -
ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
final
-
maxMessageSize
→ Input<
int?> ? -
Limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 1048576 bytes (1024 KiB). The default for this attribute is 262144 (256 KiB).
final
-
messageRetentionSeconds
→ Input<
int?> ? -
Number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days).
final
-
name
→ Input<
String?> ? -
Name of the queue. Queue names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 80 characters long. For a FIFO (first-in-first-out) queue, the name must end with the
.fifosuffix. If omitted, the provider will assign a random, unique name. Conflicts withnamePrefix.final -
namePrefix
→ Input<
String?> ? -
Creates a unique name beginning with the specified prefix. Conflicts with
name.final -
policy
→ Input<
String?> ? -
JSON policy for the SQS queue. For more information about building AWS IAM policy documents see the AWS IAM Policy Document Guide. The provider will only perform drift detection of its value when present in a configuration. It is preferred to use the
aws.sqs.QueuePolicyresource instead.final -
receiveWaitTimeSeconds
→ Input<
int?> ? -
Time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default for this attribute is 0, meaning that the call will return immediately.
final
-
redriveAllowPolicy
→ Input<
String?> ? -
JSON policy to set up the Dead Letter Queue redrive permission, see AWS docs. The provider will only perform drift detection of its value when present in a configuration. It is preferred to use the
aws.sqs.RedriveAllowPolicyresource instead.final -
redrivePolicy
→ Input<
String?> ? -
JSON policy to set up the Dead Letter Queue, see AWS docs. The provider will only perform drift detection of its value when present in a configuration. It is preferred to use the
aws.sqs.RedrivePolicyresource instead. Note: when specifyingmaxReceiveCount, you must specify it as an integer (5), and not a string ("5").final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
sqsManagedSseEnabled
→ Input<
bool?> ? -
Boolean to enable server-side encryption (SSE) of message content with SQS-owned encryption keys. See Encryption at rest. The provider will only perform drift detection of its value when present in a configuration.
final
-
Map of tags to assign to the queue. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
url
→ Input<
String?> ? -
Same as
id: The URL for the created Amazon SQS queue.final -
visibilityTimeoutSeconds
→ Input<
int?> ? -
Visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default for this attribute is 30. For more information about visibility timeout, see AWS docs.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited