aws-cdk: SQS - Unknown Attribute FifoQueue when setting fifo to false in Queue Props

Setting fifo to false in QueueProps when creating an SQS queue causes the deploy to fail.

Reproduction Steps

This is the code used to create the queue. It is part of a reusable component, I have made a workaround of only setting the fifo prop if it is set to true and everything works as expected.

return new sqs.Queue(stack, name, {
      encryption: encrypted ? sqs.QueueEncryption.KMS_MANAGED : sqs.QueueEncryption.UNENCRYPTED,
      fifo,
      queueName: name,
      retentionPeriod,
      visibilityTimeout
    });

Error Log

This error shows up under CloudFormation events as the reason why creating the queue failed. Unknown Attribute FifoQueue. (Service: AmazonSQS; Status Code: 400; Error Code: InvalidAttributeName; Request ID: <REQUEST_ID>)

Environment

CLI Version : 1.45.0
Framework Version: 1.45.0
Node.js Version: v14.3.0
OS : macOS Catalina v10.15.15
Language (Version): TypeScript (^3.9.5)

Other

I found a similar issue report here: AWS PHP SDK Github issue

This is 🐛 Bug Report

About this issue

Original URL
State: open
Created 4 years ago
Reactions: 29
Comments: 18 (3 by maintainers)

Most upvoted comments

I’ve just bumped into this issue as well.

It would make a lot of sense to reflect this in the docs. Currently docs for interface QueueProps reads: fifo? | boolean. Would be better to make it some enum like true or undefined.

suankan on Oct 4, 2020

Just encountered this in CDK v2 using Typescript. Agree with comments elsewhere in the thread - update docs and/or make this an enum of true | undefined. Minor issue but easily fixed.

wilhen01 on Jun 22, 2022

Hey there. Looks like this is a known issue with cloudformation. They have an issue in their roadmap for it.

We can potentially perform some logic inside of the construct to pass undefined to the L1 when the user passes false to cover this from our side. I can’t imagine that causing any conflicts in the future. @eladb opinions on diverging from CFN here to prevent this error? Should be non-breaking as far as I can tell.

That is exactly what you’re workaround is doing but one level higher. Anyone else encountering this can do that as well in the meantime.

MrArnoldPalmer on Jun 17, 2020

Workaround in Typescript CDK

const additionalProperties = props.fifo
            ? {
                  fifo: true,
              }
            : {};

queue = new aws_sqs.Queue(this, `SomeQueue`, {
            queueName: name,
            ...additionalProperties
})

cyber-gh on Aug 10, 2023

This issue has received a significant amount of attention so we are automatically upgrading its priority. A member of the community will see the re-prioritization and provide an update on the issue.

github-actions[bot] on Apr 2, 2023

bump - same issue, in python 3.7 using:

 self._queue=sqs.Queue(
            scope, 
            QUEUE_ID_PREFIX + name, 
            fifo=True if FIFO_ENABLED else None,
            removal_policy=REMOVAL_POLICY
        )

fixed this for me.

ParallelPlatypus on Feb 24, 2021

Bump, same issue. Fixed using @ParallelPlatypus’s method (thank you!) fifo=True if fifo_enabled==True else None

matt-challe on Apr 9, 2024

It appears this issue has moved to Coming Soon on the CloudFormation roadmap. We should continue to wait for CloudFormation to push this as it appears the wait will not be much longer

peterwoodworth on Apr 18, 2023

Seeing this as well. The documentation is literally incorrect in claiming that FifoQueue is boolean.

emmavray on Dec 22, 2021

Seeing this as well in typescript.

noam-alchemy on Nov 3, 2021