# Amazon Simple Queue Service Construct Library
<!--BEGIN STABILITY BANNER-->---
> AWS CDK v1 has reached End-of-Support on 2023-06-01.
> This package is no longer being updated, and users should migrate to AWS CDK v2.
>
> For more information on how to migrate, see the [*Migrating to AWS CDK v2* guide](https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html).
---
<!--END STABILITY BANNER-->
Amazon Simple Queue Service (SQS) is a fully managed message queuing service that
enables you to decouple and scale microservices, distributed systems, and serverless
applications. SQS eliminates the complexity and overhead associated with managing and
operating message oriented middleware, and empowers developers to focus on differentiating work.
Using SQS, you can send, store, and receive messages between software components at any volume,
without losing messages or requiring other services to be available.
## Installation
Import to your project:
```python
import aws_cdk.aws_sqs as sqs
```
## Basic usage
Here's how to add a basic queue to your application:
```python
sqs.Queue(self, "Queue")
```
## Encryption
If you want to encrypt the queue contents, set the `encryption` property. You can have
the messages encrypted with a key that SQS manages for you, or a key that you
can manage yourself.
```python
# Use managed key
sqs.Queue(self, "Queue",
encryption=sqs.QueueEncryption.KMS_MANAGED
)
# Use custom key
my_key = kms.Key(self, "Key")
sqs.Queue(self, "Queue",
encryption=sqs.QueueEncryption.KMS,
encryption_master_key=my_key
)
```
## First-In-First-Out (FIFO) queues
FIFO queues give guarantees on the order in which messages are dequeued, and have additional
features in order to help guarantee exactly-once processing. For more information, see
the SQS manual. Note that FIFO queues are not available in all AWS regions.
A queue can be made a FIFO queue by either setting `fifo: true`, giving it a name which ends
in `".fifo"`, or by enabling a FIFO specific feature such as: content-based deduplication,
deduplication scope or fifo throughput limit.
Raw data
{
"_id": null,
"home_page": "https://github.com/aws/aws-cdk",
"name": "aws-cdk.aws-sqs",
"maintainer": "",
"docs_url": null,
"requires_python": "~=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Amazon Web Services",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/3d/fc/b1b5a0354338196bbf2a4d1cfde0a29ffcab3c4762402fc648c55c177cb2/aws-cdk.aws-sqs-1.204.0.tar.gz",
"platform": null,
"description": "# Amazon Simple Queue Service Construct Library\n\n<!--BEGIN STABILITY BANNER-->---\n\n\n\n\n> AWS CDK v1 has reached End-of-Support on 2023-06-01.\n> This package is no longer being updated, and users should migrate to AWS CDK v2.\n>\n> For more information on how to migrate, see the [*Migrating to AWS CDK v2* guide](https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html).\n\n---\n<!--END STABILITY BANNER-->\n\nAmazon Simple Queue Service (SQS) is a fully managed message queuing service that\nenables you to decouple and scale microservices, distributed systems, and serverless\napplications. SQS eliminates the complexity and overhead associated with managing and\noperating message oriented middleware, and empowers developers to focus on differentiating work.\nUsing SQS, you can send, store, and receive messages between software components at any volume,\nwithout losing messages or requiring other services to be available.\n\n## Installation\n\nImport to your project:\n\n```python\nimport aws_cdk.aws_sqs as sqs\n```\n\n## Basic usage\n\nHere's how to add a basic queue to your application:\n\n```python\nsqs.Queue(self, \"Queue\")\n```\n\n## Encryption\n\nIf you want to encrypt the queue contents, set the `encryption` property. You can have\nthe messages encrypted with a key that SQS manages for you, or a key that you\ncan manage yourself.\n\n```python\n# Use managed key\nsqs.Queue(self, \"Queue\",\n encryption=sqs.QueueEncryption.KMS_MANAGED\n)\n\n# Use custom key\nmy_key = kms.Key(self, \"Key\")\n\nsqs.Queue(self, \"Queue\",\n encryption=sqs.QueueEncryption.KMS,\n encryption_master_key=my_key\n)\n```\n\n## First-In-First-Out (FIFO) queues\n\nFIFO queues give guarantees on the order in which messages are dequeued, and have additional\nfeatures in order to help guarantee exactly-once processing. For more information, see\nthe SQS manual. Note that FIFO queues are not available in all AWS regions.\n\nA queue can be made a FIFO queue by either setting `fifo: true`, giving it a name which ends\nin `\".fifo\"`, or by enabling a FIFO specific feature such as: content-based deduplication,\ndeduplication scope or fifo throughput limit.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "The CDK Construct Library for AWS::SQS",
"version": "1.204.0",
"project_urls": {
"Homepage": "https://github.com/aws/aws-cdk",
"Source": "https://github.com/aws/aws-cdk.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7a5a3651c278eba94bdd81290fae9084ef8de4ebf7607b25fbc2147db6992574",
"md5": "8a797f8dc62f3688634e82d7c7380db2",
"sha256": "eec667a362dda82df8695938517cb42f423e1b63f2557b345b07b9e5b4c3b881"
},
"downloads": -1,
"filename": "aws_cdk.aws_sqs-1.204.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8a797f8dc62f3688634e82d7c7380db2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.7",
"size": 120686,
"upload_time": "2023-06-19T21:01:33",
"upload_time_iso_8601": "2023-06-19T21:01:33.022291Z",
"url": "https://files.pythonhosted.org/packages/7a/5a/3651c278eba94bdd81290fae9084ef8de4ebf7607b25fbc2147db6992574/aws_cdk.aws_sqs-1.204.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3dfcb1b5a0354338196bbf2a4d1cfde0a29ffcab3c4762402fc648c55c177cb2",
"md5": "aaaac1f55e6ac294412139cd9932e59c",
"sha256": "177105aa76957562c8174c886479c34e34e89cb95b5127c9b65dc5cc1c097c91"
},
"downloads": -1,
"filename": "aws-cdk.aws-sqs-1.204.0.tar.gz",
"has_sig": false,
"md5_digest": "aaaac1f55e6ac294412139cd9932e59c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.7",
"size": 122020,
"upload_time": "2023-06-19T21:07:42",
"upload_time_iso_8601": "2023-06-19T21:07:42.882268Z",
"url": "https://files.pythonhosted.org/packages/3d/fc/b1b5a0354338196bbf2a4d1cfde0a29ffcab3c4762402fc648c55c177cb2/aws-cdk.aws-sqs-1.204.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-19 21:07:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aws",
"github_project": "aws-cdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aws-cdk.aws-sqs"
}
JSON
