Package software.amazon.awscdk.services.sqs

Class CfnQueue

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.sqs.CfnQueue
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:38.025Z") @Stability(Stable) public class CfnQueue extends CfnResource implements IInspectable
A CloudFormation AWS::SQS::Queue.

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 ( AWS 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.services.sqs.*;
 Object redriveAllowPolicy;
 Object redrivePolicy;
 CfnQueue cfnQueue = CfnQueue.Builder.create(this, "MyCfnQueue")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnQueue

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

    • CfnQueue

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

    • CfnQueue

      @Stability(Stable) public CfnQueue(@NotNull Construct scope, @NotNull String id, @Nullable CfnQueueProps props)
      Create a new AWS::SQS::Queue.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnQueue

      @Stability(Stable) public CfnQueue(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::SQS::Queue.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Returns the Amazon Resource Name (ARN) of the queue.

      For example: arn:aws:sqs:us-east-2:123456789012:mystack-myqueue-15PG5C2FC1CW8 .

    • getAttrQueueName

      @Stability(Stable) @NotNull public String getAttrQueueName()
      Returns the queue name.

      For example: mystack-myqueue-1VF9BKQH5BJVI .

    • getAttrQueueUrl

      @Stability(Stable) @NotNull public String getAttrQueueUrl()
      Returns the URLs of the queues from the policy.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags that you attach to this queue.

      For more information, see Resource tag in the AWS CloudFormation User Guide .

    • getRedriveAllowPolicy

      @Stability(Stable) @NotNull public Object getRedriveAllowPolicy()
      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:

      • redrivePermission : The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:
      • allowAll : (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.
      • denyAll : No source queues can specify this queue as the dead-letter queue.
      • byQueue : Only queues specified by the sourceQueueArns parameter can specify this queue as the dead-letter queue.
      • sourceQueueArns : The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the redrivePermission parameter is set to byQueue . You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter to allowAll .

    • setRedriveAllowPolicy

      @Stability(Stable) public void setRedriveAllowPolicy(@NotNull Object value)
      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:

      • redrivePermission : The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are:
      • allowAll : (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue.
      • denyAll : No source queues can specify this queue as the dead-letter queue.
      • byQueue : Only queues specified by the sourceQueueArns parameter can specify this queue as the dead-letter queue.
      • sourceQueueArns : The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the redrivePermission parameter is set to byQueue . You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter to allowAll .

    • getRedrivePolicy

      @Stability(Stable) @NotNull public Object getRedrivePolicy()
      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:

      • deadLetterTargetArn : The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
      • maxReceiveCount : The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.

      The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.

      JSON

      { "deadLetterTargetArn" : *String* , "maxReceiveCount" : *Integer* }

      YAML

      deadLetterTargetArn : *String*

      maxReceiveCount : *Integer*

    • setRedrivePolicy

      @Stability(Stable) public void setRedrivePolicy(@NotNull Object value)
      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:

      • deadLetterTargetArn : The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
      • maxReceiveCount : The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.

      The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.

      JSON

      { "deadLetterTargetArn" : *String* , "maxReceiveCount" : *Integer* }

      YAML

      deadLetterTargetArn : *String*

      maxReceiveCount : *Integer*

    • getContentBasedDeduplication

      @Stability(Stable) @Nullable public Object getContentBasedDeduplication()
      For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication.

      During the deduplication interval, Amazon 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) action in the Amazon SQS API Reference .

    • setContentBasedDeduplication

      @Stability(Stable) public void setContentBasedDeduplication(@Nullable Boolean value)
      For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication.

      During the deduplication interval, Amazon 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) action in the Amazon SQS API Reference .

    • setContentBasedDeduplication

      @Stability(Stable) public void setContentBasedDeduplication(@Nullable IResolvable value)
      For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication.

      During the deduplication interval, Amazon 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) action in the Amazon SQS API Reference .

    • getDeduplicationScope

      @Stability(Stable) @Nullable public String getDeduplicationScope()
      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 Amazon SQS Developer Guide .

    • setDeduplicationScope

      @Stability(Stable) public void setDeduplicationScope(@Nullable String value)
      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 Amazon SQS Developer Guide .

    • getDelaySeconds

      @Stability(Stable) @Nullable public Number getDelaySeconds()
      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 .

    • setDelaySeconds

      @Stability(Stable) public void setDelaySeconds(@Nullable Number value)
      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 .

    • getFifoQueue

      @Stability(Stable) @Nullable public Object getFifoQueue()
      If set to true, creates a FIFO queue.

      If you don't specify this property, Amazon SQS creates a standard queue. For more information, see FIFO queues in the Amazon SQS Developer Guide .

    • setFifoQueue

      @Stability(Stable) public void setFifoQueue(@Nullable Boolean value)
      If set to true, creates a FIFO queue.

      If you don't specify this property, Amazon SQS creates a standard queue. For more information, see FIFO queues in the Amazon SQS Developer Guide .

    • setFifoQueue

      @Stability(Stable) public void setFifoQueue(@Nullable IResolvable value)
      If set to true, creates a FIFO queue.

      If you don't specify this property, Amazon SQS creates a standard queue. For more information, see FIFO queues in the Amazon SQS Developer Guide .

    • getFifoThroughputLimit

      @Stability(Stable) @Nullable public String getFifoThroughputLimit()
      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 Amazon SQS Developer Guide .

    • setFifoThroughputLimit

      @Stability(Stable) public void setFifoThroughputLimit(@Nullable String value)
      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 Amazon SQS Developer Guide .

    • getKmsDataKeyReusePeriodSeconds

      @Stability(Stable) @Nullable public Number getKmsDataKeyReusePeriodSeconds()
      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.

      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 AWS KMS , which might incur charges after Free Tier. For more information, see Encryption at rest in the Amazon SQS Developer Guide .

    • setKmsDataKeyReusePeriodSeconds

      @Stability(Stable) public void setKmsDataKeyReusePeriodSeconds(@Nullable Number value)
      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.

      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 AWS KMS , which might incur charges after Free Tier. For more information, see Encryption at rest in the Amazon SQS Developer Guide .

    • getKmsMasterKeyId

      @Stability(Stable) @Nullable public String getKmsMasterKeyId()
      The ID of an AWS Key Management Service (KMS) for Amazon SQS , or a custom KMS.

      To use the AWS managed KMS for Amazon SQS , specify a (default) alias ARN, alias name (e.g. alias/aws/sqs ), key ARN, or key ID. For more information, see the following:

    • setKmsMasterKeyId

      @Stability(Stable) public void setKmsMasterKeyId(@Nullable String value)
      The ID of an AWS Key Management Service (KMS) for Amazon SQS , or a custom KMS.

      To use the AWS managed KMS for Amazon SQS , specify a (default) alias ARN, alias name (e.g. alias/aws/sqs ), key ARN, or key ID. For more information, see the following:

    • getMaximumMessageSize

      @Stability(Stable) @Nullable public Number getMaximumMessageSize()
      The limit of how many bytes that a message can contain before Amazon 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).

    • setMaximumMessageSize

      @Stability(Stable) public void setMaximumMessageSize(@Nullable Number value)
      The limit of how many bytes that a message can contain before Amazon 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).

    • getMessageRetentionPeriod

      @Stability(Stable) @Nullable public Number getMessageRetentionPeriod()
      The number of seconds that Amazon 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).

    • setMessageRetentionPeriod

      @Stability(Stable) public void setMessageRetentionPeriod(@Nullable Number value)
      The number of seconds that Amazon 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).

    • getQueueName

      @Stability(Stable) @Nullable public String getQueueName()
      A name for the queue.

      To create a FIFO queue, the name of your FIFO queue must end with the .fifo suffix. For more information, see FIFO queues in the Amazon SQS Developer Guide .

      If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the queue name. For more information, see Name type in the AWS CloudFormation User Guide .

      If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

    • setQueueName

      @Stability(Stable) public void setQueueName(@Nullable String value)
      A name for the queue.

      To create a FIFO queue, the name of your FIFO queue must end with the .fifo suffix. For more information, see FIFO queues in the Amazon SQS Developer Guide .

      If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the queue name. For more information, see Name type in the AWS CloudFormation User Guide .

      If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

    • getReceiveMessageWaitTimeSeconds

      @Stability(Stable) @Nullable public Number getReceiveMessageWaitTimeSeconds()
      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 Amazon SQS Developer Guide .

    • setReceiveMessageWaitTimeSeconds

      @Stability(Stable) public void setReceiveMessageWaitTimeSeconds(@Nullable Number value)
      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 Amazon SQS Developer Guide .

    • getSqsManagedSseEnabled

      @Stability(Stable) @Nullable public Object getSqsManagedSseEnabled()
      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 ).

    • setSqsManagedSseEnabled

      @Stability(Stable) public void setSqsManagedSseEnabled(@Nullable Boolean value)
      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 ).

    • setSqsManagedSseEnabled

      @Stability(Stable) public void setSqsManagedSseEnabled(@Nullable IResolvable value)
      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 ).

    • getVisibilityTimeout

      @Stability(Stable) @Nullable public Number getVisibilityTimeout()
      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 Amazon SQS queue visibility timeouts, see Visibility timeout in the Amazon SQS Developer Guide .

    • setVisibilityTimeout

      @Stability(Stable) public void setVisibilityTimeout(@Nullable Number value)
      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 Amazon SQS queue visibility timeouts, see Visibility timeout in the Amazon SQS Developer Guide .