Package software.amazon.awscdk.cfnpropertymixins.services.sqs

Class CfnQueuePropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.sqs.CfnQueuePropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:20:05.667Z") @Stability(Stable) public class CfnQueuePropsMixin extends Mixin implements software.constructs.IMixin
The AWS::SQS::Queue resource creates an Amazon SQS standard or FIFO queue.

Keep the following caveats in mind:

  • If you don't specify the FifoQueue property, Amazon SQS creates a standard queue.

You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving from a standard queue to a FIFO queue in the Amazon SQS Developer Guide .

  • If you don't provide a value for a property, the queue is created with the default value for the property.
  • If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
  • To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.

For more information about creating FIFO (first-in-first-out) queues, see Creating an Amazon SQS queue ( CloudFormation ) in the Amazon SQS Developer Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.sqs.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 Object redriveAllowPolicy;
 Object redrivePolicy;
 CfnQueuePropsMixin cfnQueuePropsMixin = CfnQueuePropsMixin.Builder.create(CfnQueueMixinProps.builder()
         .contentBasedDeduplication(false)
         .deduplicationScope("deduplicationScope")
         .delaySeconds(123)
         .fifoQueue(false)
         .fifoThroughputLimit("fifoThroughputLimit")
         .kmsDataKeyReusePeriodSeconds(123)
         .kmsMasterKeyId("kmsMasterKeyId")
         .maximumMessageSize(123)
         .messageRetentionPeriod(123)
         .queueName("queueName")
         .receiveMessageWaitTimeSeconds(123)
         .redriveAllowPolicy(redriveAllowPolicy)
         .redrivePolicy(redrivePolicy)
         .sqsManagedSseEnabled(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .visibilityTimeout(123)
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CfnQueuePropsMixin.Builder
    A fluent builder for CfnQueuePropsMixin.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IMixin

    software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final List<String>
    CFN_PROPERTY_KEYS
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    CfnQueuePropsMixin(CfnQueueMixinProps props)
    Create a mixin to apply properties to AWS::SQS::Queue.
     
    CfnQueuePropsMixin(CfnQueueMixinProps props, CfnPropertyMixinOptions options)
    Create a mixin to apply properties to AWS::SQS::Queue.
    protected
    CfnQueuePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    CfnQueuePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    applyTo(software.constructs.IConstruct construct)
    Apply the mixin properties to the construct.
    protected CfnQueueMixinProps
    getProps()
     
    protected IMergeStrategy
    getStrategy()
     
    Boolean
    supports(software.constructs.IConstruct construct)
    Check if this mixin supports the given construct.

    Methods inherited from class software.amazon.awscdk.Mixin

    isMixin

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnQueuePropsMixin

      protected CfnQueuePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnQueuePropsMixin

      protected CfnQueuePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnQueuePropsMixin

      @Stability(Stable) public CfnQueuePropsMixin(@NotNull CfnQueueMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::SQS::Queue.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnQueuePropsMixin

      @Stability(Stable) public CfnQueuePropsMixin(@NotNull CfnQueueMixinProps props)
      Create a mixin to apply properties to AWS::SQS::Queue.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnQueueMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()