Requirements

Name Version
terraform >= 1.9.0

Inputs

Name Description Type Default Required
allowed_arns A list of AWS account IDs allowed to access this resource list(any) null no
aws_account_id The AWS Account ID (numeric) string n/a yes
component The name of the tfscaffold component string n/a yes
content_based_deduplication Enables content-based deduplication for FIFO queues bool false no
create_dlq Create a DLQ bool false no
default_tags A map of default tags to apply to all taggable resources within the component map(string) {} no
delay_seconds Time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). number 0 no
dlq_alarm_config Object of optional CloudWatch alarm settings for the DLQ messages alarm <pre>object({
comparison_operator = optional(string, “GreaterThanThreshold”)
evaluation_periods = optional(number, 1)
period = optional(number, 300)
statistic = optional(string, “Sum”)
threshold = optional(number, 0)
actions_enabled = optional(bool, true)
treat_missing_data = optional(string, “notBreaching”)
})</pre>		 {} no
dlq_message_retention_seconds The number of seconds Amazon SQS retains a message on the DLQ. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days) number 1209600 no
enable_dlq_alarm Create a CloudWatch alarm when messages are visible in the DLQ bool true no
enable_queue_oldest_message_alarm Create a CloudWatch alarm when the oldest visible message age breaches the configured threshold on the main queue bool true no
environment The name of the tfscaffold environment string n/a yes
fifo_queue Boolean designating a FIFO queue bool false no
kms_data_key_reuse_period_seconds The 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) number 300 no
max_message_size The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB) number 262144 no
max_receive_count The maximum number of times a message can be received before being sent to the DLQ number 3 no
message_retention_seconds The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days) number null no
name Name of the SQS Queue string n/a yes
project The name of the tfscaffold project string n/a yes
queue_oldest_message_alarm_config Object of optional CloudWatch alarm settings for the main queue oldest message age alarm <pre>object({
comparison_operator = optional(string, “GreaterThanThreshold”)
evaluation_periods = optional(number, 1)
period = optional(number, 300)
statistic = optional(string, “Maximum”)
threshold = optional(number, 300)
actions_enabled = optional(bool, true)
treat_missing_data = optional(string, “notBreaching”)
})</pre>		 {} no
region The AWS Region string n/a yes
sqs_kms_key_arn ARN of the KMS key to encrypt SQS queue messages string n/a yes
sqs_policy_overload Optional additional policy to extend the SQS Resource Policy string "" no
visibility_timeout_seconds The visibility timeout for the queue. An integer from 0 to 43200 (12 hours) number 300 no

Outputs

Name Description
sqs_dlq_arn The ARN of the SQS dead-letter queue
sqs_dlq_messages_alarm_arn The ARN of the CloudWatch alarm for messages in the SQS dead-letter queue
sqs_dlq_messages_alarm_name The name of the CloudWatch alarm for messages in the SQS dead-letter queue
sqs_dlq_name The name of the SQS dead-letter queue
sqs_dlq_url The URL of the SQS dead-letter queue
sqs_queue_arn The ARN of the SQS queue
sqs_queue_name The name of the SQS queue
sqs_queue_oldest_message_alarm_arn The ARN of the CloudWatch alarm for oldest visible message age in the SQS queue
sqs_queue_oldest_message_alarm_name The name of the CloudWatch alarm for oldest visible message age in the SQS queue
sqs_queue_url The URL of the SQS queue