Skip to content

Commit 720e682

Browse files
committed
docs: Add PubSub SQS section to README file
1 parent a9f9f67 commit 720e682

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ SDK, the Go version.
3030
- [Usage of ORM](#usage-of-orm)
3131
- [PubSub](#pubsub)
3232
- [Kafka specific configuration](#kafka-specific-configuration)
33+
- [SQS specific configuration](#sqs-specific-configuration)
3334
- [Cache](#cache)
3435
- [Redis](#redis-specific-configuration)
3536
- [Experimentation](#experimentation)
@@ -849,6 +850,23 @@ common: &common
849850
subscriber:
850851
topic: "test-topic"
851852
group_id: ""
853+
sqs:
854+
subscriber:
855+
# Set by APP_PUBSUB_SQS_SUBSCRIBER_ENABLED env variable
856+
enabled: true
857+
# Set by APP_PUBSUB_SQS_SUBSCRIBER_QUEUE_URL env variable
858+
queue_url: "https://sqs.us-east-2.amazonaws.com/123456789012/test-queue"
859+
# Set by APP_PUBSUB_SQS_SUBSCRIBER_MAX_MESSAGES env variable
860+
max_messages: 10
861+
# Set by APP_PUBSUB_SQS_SUBSCRIBER_WORKERS env variable
862+
workers: 1
863+
# Set by APP_PUBSUB_SQS_SUBSCRIBER_WAIT_TIME env variable
864+
wait_time: "10s"
865+
publisher:
866+
# Set by APP_PUBSUB_SQS_PUBLISHER_ENABLED env variable
867+
enabled: true
868+
# Set by APP_PUBSUB_SQS_PUBLISHER_QUEUE_URL env variable
869+
queue_url: "https://sqs.us-east-2.amazonaws.com/123456789012/test-queue"
852870
```
853871
854872
#### Kafka specific configuration
@@ -920,6 +938,25 @@ To authenticate the requests to Kafka, Go SDK provides a configuration set for T
920938
| Assumable role | This role will be used to establish connection to AWS MSK ignoring the static credentials | `role` | `APP_PUBSUB_KAFKA_SASL_AWS_MSK_IAM_ROLE` | string | AWS ARN string |
921939
| Session name | Will be passed to AWS STS when assuming the role | `session_name` | `APP_PUBSUB_KAFKA_SASL_AWS_MSK_IAM_SESSION_NAME` | string | application |
922940

941+
#### SQS specific configuration
942+
943+
Under the hood, the SQS integration relies on the provided SQS client. To learn more about the AWS services initialization, check the [AWS service configuration](#aws-service-configuration).
944+
945+
**Subscriber**:
946+
947+
| Setting | Description | YAML variable | Environment variable (ENV) | Type | Possible Values |
948+
|-------------------|-------------------------------------------------------------------------------------------------|-----------------------|---------------------------------------------------|---------|-----------------|
949+
| Queue URL | URL of the SQS queue | `queue_url` | `APP_PUBSUB_SQS_SUBSCRIBER_QUEUE_URL` | string | queue URL |
950+
| Max messages | Maximum number of messages to retrieve from the queue per polling iteration | `max_messages` | `APP_PUBSUB_SQS_SUBSCRIBER_MAX_MESSAGES` | number | 1,2... |
951+
| Number of workers | Number of workers processing incoming messages | `workers` | `APP_PUBSUB_SQS_SUBSCRIBER_WORKERS` | number | 1,2... |
952+
| Wait time | The maximum amount of time in time.Duration to wait for messages to be available for retrieval. | `wait_time` | `APP_PUBSUB_SQS_SUBSCRIBER_WAIT_TIME` | string | 10s |
953+
954+
**Publisher**:
955+
956+
| Setting | Description | YAML variable | Environment variable (ENV) | Type | Possible Values |
957+
|-----------|-----------------------|-----------------------|---------------------------------------------------|---------|-----------------|
958+
| Queue URL | URL of the SQS queue | `queue_url` | `APP_PUBSUB_SQS_PUBLISHER_QUEUE_URL` | string | queue URL |
959+
923960
### Cache
924961

925962
`go-sdk` provides a convenient way to create an application Cache configuration.

0 commit comments

Comments
 (0)