@aws-cdk/aws-sqs

  • Version 1.155.0
  • Published
  • 453 kB
  • 5 dependencies
  • Apache-2.0 license

Install

npm i @aws-cdk/aws-sqs
yarn add @aws-cdk/aws-sqs
pnpm add @aws-cdk/aws-sqs

Overview

The CDK Construct Library for AWS::SQS

Index

Classes

Interfaces

Enums

Classes

class CfnQueue

class CfnQueue extends cdk.CfnResource implements cdk.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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-moving.html) 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) 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 )](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/screate-queue-cloudformation.html) in the *Amazon SQS Developer Guide* .

    AWS::SQS::Queue external

    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html

constructor

constructor(scope: cdk.Construct, id: string, props?: CfnQueueProps);
  • Create a new AWS::SQS::Queue.

    Parameter scope

    scope in which this resource is defined

    Parameter id

    scoped id of the resource

    Parameter props

    resource properties

property attrArn

readonly attrArn: string;
  • Returns the Amazon Resource Name (ARN) of the queue. For example: arn:aws:sqs:us-east-2:123456789012:mystack-myqueue-15PG5C2FC1CW8 . Arn

property attrQueueName

readonly attrQueueName: string;
  • Returns the queue name. For example: mystack-myqueue-1VF9BKQH5BJVI . QueueName

property attrQueueUrl

readonly attrQueueUrl: string;
  • QueueUrl

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;
  • The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

    property contentBasedDeduplication

    contentBasedDeduplication: any;
    • 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* .

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-contentbaseddeduplication

    property deduplicationScope

    deduplicationScope: string;
    • 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Amazon SQS Developer Guide* .

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-deduplicationscope

    property delaySeconds

    delaySeconds: number;
    • 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 .

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-delayseconds

    property fifoQueue

    fifoQueue: any;
    • 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Amazon SQS Developer Guide* .

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-fifoqueue

    property fifoThroughputLimit

    fifoThroughputLimit: string;
    • 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Amazon SQS Developer Guide* .

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-fifothroughputlimit

    property kmsDataKeyReusePeriodSeconds

    kmsDataKeyReusePeriodSeconds: number;
    • 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Amazon SQS Developer Guide* .

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-kmsdatakeyreuseperiodseconds

    property kmsMasterKeyId

    kmsMasterKeyId: string;
    • The ID of an AWS managed customer master key (CMK) for Amazon SQS or a custom CMK. To use the AWS managed CMK for Amazon SQS , specify the (default) alias alias/aws/sqs . For more information, see the following:

      - [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Amazon SQS Developer Guide* - [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *Amazon SQS API Reference* - The Customer Master Keys section of the [AWS Key Management Service Best Practices](https://docs.aws.amazon.com/https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-kmsmasterkeyid

    property maximumMessageSize

    maximumMessageSize: number;
    • 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).

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-maximummessagesize

    property messageRetentionPeriod

    messageRetentionPeriod: number;
    • 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).

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-messageretentionperiod

    property queueName

    queueName: string;
    • 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) 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.

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-queuename

    property receiveMessageWaitTimeSeconds

    receiveMessageWaitTimeSeconds: number;
    • 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Amazon SQS Developer Guide* .

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-receivemessagewaittimeseconds

    property redriveAllowPolicy

    redriveAllowPolicy: any;
    • 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 .

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-redriveallowpolicy

    property redrivePolicy

    redrivePolicy: any;
    • 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*

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-redrivepolicy

    property tags

    readonly tags: cdk.TagManager;
    • The tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide* .

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-tags

    property visibilityTimeout

    visibilityTimeout: number;
    • 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Amazon SQS Developer Guide* .

      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-visibilitytimeout

    method inspect

    inspect: (inspector: cdk.TreeInspector) => void;
    • Examines the CloudFormation resource and discloses attributes.

      Parameter inspector

      tree inspector to collect and process attributes

    method renderProperties

    protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
    };

      class CfnQueuePolicy

      class CfnQueuePolicy extends cdk.CfnResource implements cdk.IInspectable {}
      • A CloudFormation AWS::SQS::QueuePolicy

        The AWS::SQS::QueuePolicy type applies a policy to Amazon SQS queues. For an example snippet, see [Declaring an Amazon SQS policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-sqs-policy) in the *AWS CloudFormation User Guide* .

        AWS::SQS::QueuePolicy external

        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html

      constructor

      constructor(scope: cdk.Construct, id: string, props: CfnQueuePolicyProps);
      • Create a new AWS::SQS::QueuePolicy.

        Parameter scope

        scope in which this resource is defined

        Parameter id

        scoped id of the resource

        Parameter props

        resource properties

      property CFN_RESOURCE_TYPE_NAME

      static readonly CFN_RESOURCE_TYPE_NAME: string;
      • The CloudFormation resource type name for this resource class.

      property cfnProperties

      readonly cfnProperties: { [key: string]: any };

        property policyDocument

        policyDocument: any;
        • A policy document that contains the permissions for the specified Amazon SQS queues. For more information about Amazon SQS policies, see [Using custom policies with the Amazon SQS access policy language](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html) in the *Amazon SQS Developer Guide* .

          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html#cfn-sqs-queuepolicy-policydoc

        property queues

        queues: string[];
        • The URLs of the queues to which you want to add the policy. You can use the [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) function to specify an [AWS::SQS::Queue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html) resource.

          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html#cfn-sqs-queuepolicy-queues

        method inspect

        inspect: (inspector: cdk.TreeInspector) => void;
        • Examines the CloudFormation resource and discloses attributes.

          Parameter inspector

          tree inspector to collect and process attributes

        method renderProperties

        protected renderProperties: (props: { [key: string]: any }) => {
        [key: string]: any;
        };

          class Queue

          class Queue extends QueueBase {}
          • A new Amazon SQS queue

          constructor

          constructor(scope: Construct, id: string, props?: QueueProps);

            property autoCreatePolicy

            protected readonly autoCreatePolicy: boolean;

              property deadLetterQueue

              readonly deadLetterQueue?: DeadLetterQueue;
              • If this queue is configured with a dead-letter queue, this is the dead-letter queue settings.

              property encryptionMasterKey

              readonly encryptionMasterKey?: kms.IKey;
              • If this queue is encrypted, this is the KMS key.

              property fifo

              readonly fifo: boolean;
              • Whether this queue is an Amazon SQS FIFO queue. If false, this is a standard queue.

              property queueArn

              readonly queueArn: string;
              • The ARN of this queue

              property queueName

              readonly queueName: string;
              • The name of this queue

              property queueUrl

              readonly queueUrl: string;
              • The URL of this queue

              method fromQueueArn

              static fromQueueArn: (scope: Construct, id: string, queueArn: string) => IQueue;
              • Import an existing SQS queue provided an ARN

                Parameter scope

                The parent creating construct

                Parameter id

                The construct's name

                Parameter queueArn

                queue ARN (i.e. arn:aws:sqs:us-east-2:444455556666:queue1)

              method fromQueueAttributes

              static fromQueueAttributes: (
              scope: Construct,
              id: string,
              attrs: QueueAttributes
              ) => IQueue;
              • Import an existing queue

              class QueueBase

              abstract class QueueBase extends Resource implements IQueue {}
              • Reference to a new or existing Amazon SQS queue

              property autoCreatePolicy

              protected abstract readonly autoCreatePolicy: boolean;
              • Controls automatic creation of policy objects.

                Set by subclasses.

              property encryptionMasterKey

              abstract readonly encryptionMasterKey?: kms.IKey;
              • If this queue is server-side encrypted, this is the KMS encryption key.

              property fifo

              abstract readonly fifo: boolean;
              • Whether this queue is an Amazon SQS FIFO queue. If false, this is a standard queue.

              property queueArn

              abstract readonly queueArn: string;
              • The ARN of this queue

              property queueName

              abstract readonly queueName: string;
              • The name of this queue

              property queueUrl

              abstract readonly queueUrl: string;
              • The URL of this queue

              method addToResourcePolicy

              addToResourcePolicy: (
              statement: iam.PolicyStatement
              ) => iam.AddToResourcePolicyResult;
              • Adds a statement to the IAM resource policy associated with this queue.

                If this queue was created in this stack (new Queue), a queue policy will be automatically created upon the first call to addToPolicy. If the queue is imported (Queue.import), then this is a no-op.

              method grant

              grant: (grantee: iam.IGrantable, ...actions: string[]) => iam.Grant;
              • Grant the actions defined in queueActions to the identity Principal given on this SQS queue resource.

                Parameter grantee

                Principal to grant right to

                Parameter actions

                The actions to grant

              method grantConsumeMessages

              grantConsumeMessages: (grantee: iam.IGrantable) => iam.Grant;
              • Grant permissions to consume messages from a queue

                This will grant the following permissions:

                - sqs:ChangeMessageVisibility - sqs:DeleteMessage - sqs:ReceiveMessage - sqs:GetQueueAttributes - sqs:GetQueueUrl

                Parameter grantee

                Principal to grant consume rights to

              method grantPurge

              grantPurge: (grantee: iam.IGrantable) => iam.Grant;
              • Grant an IAM principal permissions to purge all messages from the queue.

                This will grant the following permissions:

                - sqs:PurgeQueue - sqs:GetQueueAttributes - sqs:GetQueueUrl

                Parameter grantee

                Principal to grant send rights to

              method grantSendMessages

              grantSendMessages: (grantee: iam.IGrantable) => iam.Grant;
              • Grant access to send messages to a queue to the given identity.

                This will grant the following permissions:

                - sqs:SendMessage - sqs:GetQueueAttributes - sqs:GetQueueUrl

                Parameter grantee

                Principal to grant send rights to

              method validate

              protected validate: () => string[];

                class QueuePolicy

                class QueuePolicy extends Resource {}
                • The policy for an SQS Queue

                  Policies define the operations that are allowed on this resource.

                  You almost never need to define this construct directly.

                  All AWS resources that support resource policies have a method called addToResourcePolicy(), which will automatically create a new resource policy if one doesn't exist yet, otherwise it will add to the existing policy.

                  Prefer to use addToResourcePolicy() instead.

                constructor

                constructor(scope: Construct, id: string, props: QueuePolicyProps);

                  property document

                  readonly document: PolicyDocument;
                  • The IAM policy document for this policy.

                  property queuePolicyId

                  readonly queuePolicyId: string;
                  • Not currently supported by AWS CloudFormation.

                    This attribute temporarily existed in CloudFormation, and then was removed again.

                  Interfaces

                  interface CfnQueuePolicyProps

                  interface CfnQueuePolicyProps {}
                  • Properties for defining a CfnQueuePolicy

                    external

                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html

                  property policyDocument

                  readonly policyDocument: any | cdk.IResolvable;
                  • A policy document that contains the permissions for the specified Amazon SQS queues. For more information about Amazon SQS policies, see [Using custom policies with the Amazon SQS access policy language](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html) in the *Amazon SQS Developer Guide* .

                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html#cfn-sqs-queuepolicy-policydoc

                  property queues

                  readonly queues: string[];
                  • The URLs of the queues to which you want to add the policy. You can use the [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) function to specify an [AWS::SQS::Queue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-queues.html) resource.

                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html#cfn-sqs-queuepolicy-queues

                  interface CfnQueueProps

                  interface CfnQueueProps {}
                  • Properties for defining a CfnQueue

                    external

                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html

                  property contentBasedDeduplication

                  readonly contentBasedDeduplication?: boolean | cdk.IResolvable;
                  • 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* .

                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-contentbaseddeduplication

                  property deduplicationScope

                  readonly deduplicationScope?: string;
                  • 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Amazon SQS Developer Guide* .

                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-deduplicationscope

                  property delaySeconds

                  readonly delaySeconds?: number;
                  • 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 .

                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-delayseconds

                  property fifoQueue

                  readonly fifoQueue?: boolean | cdk.IResolvable;
                  • 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Amazon SQS Developer Guide* .

                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-fifoqueue

                  property fifoThroughputLimit

                  readonly fifoThroughputLimit?: string;
                  • 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Amazon SQS Developer Guide* .

                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-fifothroughputlimit

                  property kmsDataKeyReusePeriodSeconds

                  readonly kmsDataKeyReusePeriodSeconds?: number;
                  • 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Amazon SQS Developer Guide* .

                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-kmsdatakeyreuseperiodseconds

                  property kmsMasterKeyId

                  readonly kmsMasterKeyId?: string;
                  • The ID of an AWS managed customer master key (CMK) for Amazon SQS or a custom CMK. To use the AWS managed CMK for Amazon SQS , specify the (default) alias alias/aws/sqs . For more information, see the following:

                    - [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Amazon SQS Developer Guide* - [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *Amazon SQS API Reference* - The Customer Master Keys section of the [AWS Key Management Service Best Practices](https://docs.aws.amazon.com/https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper

                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-kmsmasterkeyid

                  property maximumMessageSize

                  readonly maximumMessageSize?: number;
                  • 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).

                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-maximummessagesize

                  property messageRetentionPeriod

                  readonly messageRetentionPeriod?: number;
                  • 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).

                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-messageretentionperiod

                  property queueName

                  readonly queueName?: string;
                  • 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) 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.

                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-queuename

                  property receiveMessageWaitTimeSeconds

                  readonly receiveMessageWaitTimeSeconds?: number;
                  • 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Amazon SQS Developer Guide* .

                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-receivemessagewaittimeseconds

                  property redriveAllowPolicy

                  readonly redriveAllowPolicy?: any | cdk.IResolvable;
                  • 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 .

                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-redriveallowpolicy

                  property redrivePolicy

                  readonly redrivePolicy?: any | cdk.IResolvable;
                  • 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*

                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-redrivepolicy

                  property tags

                  readonly tags?: cdk.CfnTag[];
                  • The tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide* .

                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-tags

                  property visibilityTimeout

                  readonly visibilityTimeout?: number;
                  • 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Amazon SQS Developer Guide* .

                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html#cfn-sqs-queue-visibilitytimeout

                  interface DeadLetterQueue

                  interface DeadLetterQueue {}
                  • Dead letter queue settings

                  property maxReceiveCount

                  readonly maxReceiveCount: number;
                  • The number of times a message can be unsuccesfully dequeued before being moved to the dead-letter queue.

                  property queue

                  readonly queue: IQueue;
                  • The dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

                  interface IQueue

                  interface IQueue extends IResource {}
                  • Represents an SQS queue

                  property encryptionMasterKey

                  readonly encryptionMasterKey?: kms.IKey;
                  • If this queue is server-side encrypted, this is the KMS encryption key.

                  property fifo

                  readonly fifo: boolean;
                  • Whether this queue is an Amazon SQS FIFO queue. If false, this is a standard queue.

                  property queueArn

                  readonly queueArn: string;
                  • The ARN of this queue

                  property queueName

                  readonly queueName: string;
                  • The name of this queue

                  property queueUrl

                  readonly queueUrl: string;
                  • The URL of this queue

                  method addToResourcePolicy

                  addToResourcePolicy: (
                  statement: iam.PolicyStatement
                  ) => iam.AddToResourcePolicyResult;
                  • Adds a statement to the IAM resource policy associated with this queue.

                    If this queue was created in this stack (new Queue), a queue policy will be automatically created upon the first call to addToPolicy. If the queue is imported (Queue.import), then this is a no-op.

                  method grant

                  grant: (grantee: iam.IGrantable, ...queueActions: string[]) => iam.Grant;
                  • Grant the actions defined in queueActions to the identity Principal given on this SQS queue resource.

                    Parameter grantee

                    Principal to grant right to

                    Parameter queueActions

                    The actions to grant

                  method grantConsumeMessages

                  grantConsumeMessages: (grantee: iam.IGrantable) => iam.Grant;
                  • Grant permissions to consume messages from a queue

                    This will grant the following permissions:

                    - sqs:ChangeMessageVisibility - sqs:DeleteMessage - sqs:ReceiveMessage - sqs:GetQueueAttributes - sqs:GetQueueUrl

                    Parameter grantee

                    Principal to grant consume rights to

                  method grantPurge

                  grantPurge: (grantee: iam.IGrantable) => iam.Grant;
                  • Grant an IAM principal permissions to purge all messages from the queue.

                    This will grant the following permissions:

                    - sqs:PurgeQueue - sqs:GetQueueAttributes - sqs:GetQueueUrl

                    Parameter grantee

                    Principal to grant send rights to

                  method grantSendMessages

                  grantSendMessages: (grantee: iam.IGrantable) => iam.Grant;
                  • Grant access to send messages to a queue to the given identity.

                    This will grant the following permissions:

                    - sqs:SendMessage - sqs:GetQueueAttributes - sqs:GetQueueUrl

                    Parameter grantee

                    Principal to grant send rights to

                  interface IQueue

                  interface IQueue {}

                    method metric

                    metric: (
                    metricName: string,
                    props?: cloudwatch.MetricOptions
                    ) => cloudwatch.Metric;
                    • Return the given named metric for this Queue

                    method metricApproximateAgeOfOldestMessage

                    metricApproximateAgeOfOldestMessage: (
                    props?: cloudwatch.MetricOptions
                    ) => cloudwatch.Metric;
                    • The approximate age of the oldest non-deleted message in the queue.

                      Maximum over 5 minutes

                    method metricApproximateNumberOfMessagesDelayed

                    metricApproximateNumberOfMessagesDelayed: (
                    props?: cloudwatch.MetricOptions
                    ) => cloudwatch.Metric;
                    • The number of messages in the queue that are delayed and not available for reading immediately.

                      Maximum over 5 minutes

                    method metricApproximateNumberOfMessagesNotVisible

                    metricApproximateNumberOfMessagesNotVisible: (
                    props?: cloudwatch.MetricOptions
                    ) => cloudwatch.Metric;
                    • The number of messages that are in flight.

                      Maximum over 5 minutes

                    method metricApproximateNumberOfMessagesVisible

                    metricApproximateNumberOfMessagesVisible: (
                    props?: cloudwatch.MetricOptions
                    ) => cloudwatch.Metric;
                    • The number of messages available for retrieval from the queue.

                      Maximum over 5 minutes

                    method metricNumberOfEmptyReceives

                    metricNumberOfEmptyReceives: (
                    props?: cloudwatch.MetricOptions
                    ) => cloudwatch.Metric;
                    • The number of ReceiveMessage API calls that did not return a message.

                      Sum over 5 minutes

                    method metricNumberOfMessagesDeleted

                    metricNumberOfMessagesDeleted: (
                    props?: cloudwatch.MetricOptions
                    ) => cloudwatch.Metric;
                    • The number of messages deleted from the queue.

                      Sum over 5 minutes

                    method metricNumberOfMessagesReceived

                    metricNumberOfMessagesReceived: (
                    props?: cloudwatch.MetricOptions
                    ) => cloudwatch.Metric;
                    • The number of messages returned by calls to the ReceiveMessage action.

                      Sum over 5 minutes

                    method metricNumberOfMessagesSent

                    metricNumberOfMessagesSent: (
                    props?: cloudwatch.MetricOptions
                    ) => cloudwatch.Metric;
                    • The number of messages added to a queue.

                      Sum over 5 minutes

                    method metricSentMessageSize

                    metricSentMessageSize: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;
                    • The size of messages added to a queue.

                      Average over 5 minutes

                    interface QueueAttributes

                    interface QueueAttributes {}
                    • Reference to a queue

                    property fifo

                    readonly fifo?: boolean;
                    • Whether this queue is an Amazon SQS FIFO queue. If false, this is a standard queue.

                      In case of a FIFO queue which is imported from a token, this value has to be explicitly set to true.

                      - if fifo is not specified, the property will be determined based on the queue name (not possible for FIFO queues imported from a token)

                    property keyArn

                    readonly keyArn?: string;
                    • KMS encryption key, if this queue is server-side encrypted by a KMS key.

                      - None

                    property queueArn

                    readonly queueArn: string;
                    • The ARN of the queue.

                    property queueName

                    readonly queueName?: string;
                    • The name of the queue. if queue name is not specified, the name will be derived from the queue ARN

                    property queueUrl

                    readonly queueUrl?: string;
                    • The URL of the queue.

                      See Also

                      • https://docs.aws.amazon.com/sdk-for-net/v2/developer-guide/QueueURL.html

                        - 'https://sqs.//'

                    interface QueueBase

                    interface QueueBase {}

                      method metric

                      metric: (
                      metricName: string,
                      props?: cloudwatch.MetricOptions
                      ) => cloudwatch.Metric;
                      • Return the given named metric for this Queue

                      method metricApproximateAgeOfOldestMessage

                      metricApproximateAgeOfOldestMessage: (
                      props?: cloudwatch.MetricOptions
                      ) => cloudwatch.Metric;
                      • The approximate age of the oldest non-deleted message in the queue.

                        Maximum over 5 minutes

                      method metricApproximateNumberOfMessagesDelayed

                      metricApproximateNumberOfMessagesDelayed: (
                      props?: cloudwatch.MetricOptions
                      ) => cloudwatch.Metric;
                      • The number of messages in the queue that are delayed and not available for reading immediately.

                        Maximum over 5 minutes

                      method metricApproximateNumberOfMessagesNotVisible

                      metricApproximateNumberOfMessagesNotVisible: (
                      props?: cloudwatch.MetricOptions
                      ) => cloudwatch.Metric;
                      • The number of messages that are in flight.

                        Maximum over 5 minutes

                      method metricApproximateNumberOfMessagesVisible

                      metricApproximateNumberOfMessagesVisible: (
                      props?: cloudwatch.MetricOptions
                      ) => cloudwatch.Metric;
                      • The number of messages available for retrieval from the queue.

                        Maximum over 5 minutes

                      method metricNumberOfEmptyReceives

                      metricNumberOfEmptyReceives: (
                      props?: cloudwatch.MetricOptions
                      ) => cloudwatch.Metric;
                      • The number of ReceiveMessage API calls that did not return a message.

                        Sum over 5 minutes

                      method metricNumberOfMessagesDeleted

                      metricNumberOfMessagesDeleted: (
                      props?: cloudwatch.MetricOptions
                      ) => cloudwatch.Metric;
                      • The number of messages deleted from the queue.

                        Sum over 5 minutes

                      method metricNumberOfMessagesReceived

                      metricNumberOfMessagesReceived: (
                      props?: cloudwatch.MetricOptions
                      ) => cloudwatch.Metric;
                      • The number of messages returned by calls to the ReceiveMessage action.

                        Sum over 5 minutes

                      method metricNumberOfMessagesSent

                      metricNumberOfMessagesSent: (
                      props?: cloudwatch.MetricOptions
                      ) => cloudwatch.Metric;
                      • The number of messages added to a queue.

                        Sum over 5 minutes

                      method metricSentMessageSize

                      metricSentMessageSize: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;
                      • The size of messages added to a queue.

                        Average over 5 minutes

                      interface QueuePolicyProps

                      interface QueuePolicyProps {}
                      • Properties to associate SQS queues with a policy

                      property queues

                      readonly queues: IQueue[];
                      • The set of queues this policy applies to.

                      interface QueueProps

                      interface QueueProps {}
                      • Properties for creating a new Queue

                      property contentBasedDeduplication

                      readonly contentBasedDeduplication?: boolean;
                      • Specifies whether to enable content-based deduplication.

                        During the deduplication interval (5 minutes), Amazon SQS treats messages that are sent with identical content (excluding attributes) as duplicates and delivers only one copy of the message.

                        If you don't enable content-based deduplication and you want to deduplicate messages, provide an explicit deduplication ID in your SendMessage() call.

                        (Only applies to FIFO queues.)

                        false

                      property dataKeyReuse

                      readonly dataKeyReuse?: Duration;
                      • The length of time that Amazon SQS reuses a data key before calling KMS again.

                        The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).

                        Duration.minutes(5)

                      property deadLetterQueue

                      readonly deadLetterQueue?: DeadLetterQueue;
                      • Send messages to this queue if they were unsuccessfully dequeued a number of times.

                        no dead-letter queue

                      property deduplicationScope

                      readonly deduplicationScope?: DeduplicationScope;
                      • For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level.

                        (Only applies to FIFO queues.)

                        DeduplicationScope.QUEUE

                      property deliveryDelay

                      readonly deliveryDelay?: Duration;
                      • The time in seconds that 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.

                        0

                      property encryption

                      readonly encryption?: QueueEncryption;
                      • Whether the contents of the queue are encrypted, and by what type of key.

                        Be aware that encryption is not available in all regions, please see the docs for current availability details.

                        Unencrypted

                      property encryptionMasterKey

                      readonly encryptionMasterKey?: kms.IKey;
                      • External KMS master key to use for queue encryption.

                        Individual messages will be encrypted using data keys. The data keys in turn will be encrypted using this key, and reused for a maximum of dataKeyReuseSecs seconds.

                        If the 'encryptionMasterKey' property is set, 'encryption' type will be implicitly set to "KMS".

                        If encryption is set to KMS and not specified, a key will be created.

                      property fifo

                      readonly fifo?: boolean;
                      • Whether this a first-in-first-out (FIFO) queue.

                        false, unless queueName ends in '.fifo' or 'contentBasedDeduplication' is true.

                      property fifoThroughputLimit

                      readonly fifoThroughputLimit?: FifoThroughputLimit;
                      • For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group.

                        (Only applies to FIFO queues.)

                        FifoThroughputLimit.PER_QUEUE

                      property maxMessageSizeBytes

                      readonly maxMessageSizeBytes?: number;
                      • The limit of how many bytes that a message can contain before Amazon SQS rejects it.

                        You can specify an integer value from 1024 bytes (1 KiB) to 262144 bytes (256 KiB). The default value is 262144 (256 KiB).

                        256KiB

                      property queueName

                      readonly queueName?: string;
                      • A name for the queue.

                        If specified and this is a FIFO queue, must end in the string '.fifo'.

                        CloudFormation-generated name

                      property receiveMessageWaitTime

                      readonly receiveMessageWaitTime?: Duration;
                      • Default wait time for ReceiveMessage calls.

                        Does not wait if set to 0, otherwise waits this amount of seconds by default for messages to arrive.

                        For more information, see Amazon SQS Long Poll.

                        0

                      property removalPolicy

                      readonly removalPolicy?: RemovalPolicy;
                      • Policy to apply when the queue is removed from the stack

                        Even though queues are technically stateful, their contents are transient and it is common to add and remove Queues while rearchitecting your application. The default is therefore DESTROY. Change it to RETAIN if the messages are so valuable that accidentally losing them would be unacceptable.

                        RemovalPolicy.DESTROY

                      property retentionPeriod

                      readonly retentionPeriod?: Duration;
                      • The number of seconds that Amazon SQS retains a message.

                        You can specify an integer value from 60 seconds (1 minute) to 1209600 seconds (14 days). The default value is 345600 seconds (4 days).

                        Duration.days(4)

                      property visibilityTimeout

                      readonly visibilityTimeout?: Duration;
                      • Timeout of processing a single message.

                        After dequeuing, the processor has this much time to handle the message and delete it from the queue before it becomes visible again for dequeueing by another processor.

                        Values must be from 0 to 43200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds.

                        Duration.seconds(30)

                      Enums

                      enum DeduplicationScope

                      enum DeduplicationScope {
                      MESSAGE_GROUP = 'messageGroup',
                      QUEUE = 'queue',
                      }
                      • What kind of deduplication scope to apply

                      member MESSAGE_GROUP

                      MESSAGE_GROUP = 'messageGroup'
                      • Deduplication occurs at the message group level

                      member QUEUE

                      QUEUE = 'queue'
                      • Deduplication occurs at the message queue level

                      enum FifoThroughputLimit

                      enum FifoThroughputLimit {
                      PER_QUEUE = 'perQueue',
                      PER_MESSAGE_GROUP_ID = 'perMessageGroupId',
                      }
                      • Whether the FIFO queue throughput quota applies to the entire queue or per message group

                      member PER_MESSAGE_GROUP_ID

                      PER_MESSAGE_GROUP_ID = 'perMessageGroupId'
                      • Throughput quota applies per message group id

                      member PER_QUEUE

                      PER_QUEUE = 'perQueue'
                      • Throughput quota applies per queue

                      enum QueueEncryption

                      enum QueueEncryption {
                      UNENCRYPTED = 'NONE',
                      KMS_MANAGED = 'MANAGED',
                      KMS = 'KMS',
                      }
                      • What kind of encryption to apply to this queue

                      member KMS

                      KMS = 'KMS'
                      • Server-side encryption with a KMS key managed by the user.

                        If encryptionKey is specified, this key will be used, otherwise, one will be defined.

                      member KMS_MANAGED

                      KMS_MANAGED = 'MANAGED'
                      • Server-side KMS encryption with a master key managed by SQS.

                      member UNENCRYPTED

                      UNENCRYPTED = 'NONE'
                      • Messages in the queue are not encrypted

                      Package Files (6)

                      Dependencies (5)

                      Dev Dependencies (9)

                      Peer Dependencies (5)

                      Badge

                      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@aws-cdk/aws-sqs.

                      • Markdown
                        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@aws-cdk/aws-sqs)
                      • HTML
                        <a href="https://www.jsdocs.io/package/@aws-cdk/aws-sqs"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>