You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
title: Connecting Messaging and Queuing SQS or SNS to the AWS-CLI
4
-
description: This page explains how to connect Scaleway Messaging and Queuing SQS or SNS to the AWS-CLI
3
+
title: Connecting Queues or Topics and Events to the AWS-CLI
4
+
description: This page explains how to connect Scaleway Queues and/or Topics and Events to the AWS-CLI
5
5
content:
6
-
h1: Connecting Messaging and Queuing SQS or SNS to the AWS-CLI
7
-
paragraph: This page explains how to connect Scaleway Messaging and Queuing SQS or SNS to the AWS-CLI
6
+
h1: Connecting Queues or Topics and Events to the AWS-CLI
7
+
paragraph: This page explains how to connect Scaleway Queues and/or Topics and Events to the AWS-CLI
8
8
tags: messaging sns sqs aws-cli cli aws sdk python boto
9
9
categories:
10
10
- messaging
11
11
dates:
12
-
validation: 2024-04-09
12
+
validation: 2024-10-18
13
13
posted: 2023-01-04
14
14
---
15
15
16
-
The AWS-CLI is an open-source tool built on top of the AWS SDK for Python (Boto) that provides commands for interacting with AWS services. With minimal configuration, you can start using the AWS-CLI with Scaleway Messaging and Queuing SQS and/or SNS. This allows you to create, list and manage your queues and topics, send messages and much more, all from your command line.
16
+
The AWS-CLI is an open-source tool built on top of the AWS SDK for Python (Boto) that provides commands for interacting with AWS services. With minimal configuration, you can start using the AWS-CLI with Scaleway Queues or Scaleway Topics and Events. This allows you to create, list and manage your queues and topics, send messages and much more, all from your command line.
17
17
18
-
This guide shows you how to install the AWS-CLI and configure it to connect to Scaleway Messaging and Queuing SQS or SNS.
18
+
This guide shows you how to install the AWS-CLI and configure it to connect to Scaleway Queues or Scaleway Topics and Events.
19
19
20
20
<Macroid="requirements" />
21
21
22
22
- A Scaleway account logged into the [console](https://console.scaleway.com)
23
23
-[Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
- Valid [credentials](/serverless/messaging/how-to/create-credentials/) for SQS/SNS
24
+
- Valid [credentials](/serverless/messaging/how-to/create-credentials/) for Queues and/or Topics and Events
26
25
27
26
<Messagetype="note">
28
-
This page assumes you will use the AWS-CLI v1. For v2, see the [relevant AWS-CLI documentation page](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html).
27
+
This page assumes you will use the AWS-CLI v1.
29
28
</Message>
30
29
31
30
## How to install the AWS-CLI
32
31
33
-
To interact with Scaleway Messaging and Queuing, both `aws-cli` and `awscli-plugin-endpoint` need to be installed. The `awscli-plugin-endpoint` is a useful plugin to help people more easily access third-party providers such as Scaleway.
32
+
To interact with Scaleway Queues and Scaleway Topics and Events, both `aws-cli` and `awscli-plugin-endpoint` need to be installed. The `awscli-plugin-endpoint` is a useful plugin to help people more easily access third-party providers such as Scaleway.
34
33
35
34
Install both `aws-cli` and `awscli-plugin` using `pip`.
Now you have installed the AWS-CLI, you need to configure it for use with Scaleway Messaging and Queuing.
43
+
Now you have installed the AWS-CLI, you need to configure it for use with Scaleway Queues / Topics and Events.
45
44
46
45
1. Create a file named `~/.aws/config` by running the following command:
47
46
```
@@ -52,32 +51,32 @@ Now you have installed the AWS-CLI, you need to configure it for use with Scalew
52
51
With the most recent versions of awscli (1.29.0 or 2.13.0), the use of a plugin is not necessary. If you are using one of those versions and wish to skip this step, you can do so. Note that this will also affect your configuration file in the next step.
53
52
</Message>
54
53
55
-
2. Open the `~/.aws/config` file you just created in a text editor and edit it as follows (the SNS or SQS endpoint URL can be found in the console on the **Settings** page for the relevant protocol)
54
+
2. Open the `~/.aws/config` file you just created in a text editor and edit it as follows (the Queues or Topics and Events endpoint URL can be found in the console on the **Settings** page for the relevant product)
Optionally, you can also configure additional profiles by adding new blocks under `[sqs]` and `[sns]`. For example, you can add a third profile, `[profile aws]`, to connect to the AWS SQS/SNS service if you want:
68
+
Optionally, you can also configure additional profiles by adding new blocks under `[queues]` and `[topics_events]`. For example, you can add a third profile, `[profile aws]`, to connect to the AWS SQS/SNS service if you want:
@@ -105,14 +104,14 @@ Now you have installed the AWS-CLI, you need to configure it for use with Scalew
105
104
```
106
105
aws configure
107
106
```
108
-
109
-
4. Open the `~/.aws/credentials` file you just created, and for each protocol you want to use, add the access key and secret key you saved when you generated your [SQS or SNS credentials](/serverless/messaging/how-to/create-credentials/):
107
+
**
108
+
4. Open the `~/.aws/credentials` file you just created, and for each product (out of **Queues** and **Topics and Events**) you want to use, add the access key and secret key you saved when you generated your [credentials](/serverless/messaging/how-to/create-credentials/):
110
109
```
111
-
[sns]
110
+
[topics_events]
112
111
aws_access_key_id=<ACCESS_KEY_FOR_SNS>
113
112
aws_secret_access_key=<SECRET_KEY_FOR_SNS>
114
113
115
-
[sqs]
114
+
[queues]
116
115
aws_access_key_id=<ACCESS_KEY_FOR_SQS>
117
116
aws_secret_access_key=<SECRET_KEY_FOR_SQS>
118
117
```
@@ -126,13 +125,13 @@ Now you have installed the AWS-CLI, you need to configure it for use with Scalew
126
125
127
126
6. Test that everything is set up correctly with the following command:
128
127
```
129
-
aws sqs list-queues
128
+
aws queues list-queues
130
129
```
131
130
132
131
Use the `--profile` option if you want to test it using a different profile.
133
132
134
133
<Messagetype="tip">
135
134
Check out our dedicated documentation to find more common commands for getting started with the AWS CLI:
136
-
- The [SQS guide](/serverless/messaging/api-cli/sqs-sns-aws-cli#getting-started-with-sqs) walks you through creating and listing queues, sending messages to queues, and more.
137
-
- The [SNS guide](/serverless/messaging/api-cli/sqs-sns-aws-cli#getting-started-with-sns) shows you how to create and list topics and subscriptions, send messages to topics, and more.
135
+
- The [Queues guide](/serverless/messaging/api-cli/sqs-sns-aws-cli#getting-started-with-sqs) walks you through creating and listing queues, sending messages to queues, and more.
136
+
- The [Topics and Events guide](/serverless/messaging/api-cli/sqs-sns-aws-cli#getting-started-with-sns) shows you how to create and list topics and subscriptions, send messages to topics, and more.
Copy file name to clipboardExpand all lines: serverless/messaging/api-cli/nats-cli.mdx
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,15 @@
1
1
---
2
2
meta:
3
3
title: Using the NATS CLI
4
-
description: This page explains how to use the NATS CLI with Scaleway Messaging and Queuing
4
+
description: This page explains how to use the NATS CLI with Scaleway NATS
5
5
content:
6
6
h1: Using the NATS CLI
7
-
paragraph: This page explains how to use the NATS CLI with Scaleway Messaging and Queuing
7
+
paragraph: This page explains how to use the NATS CLI with Scaleway NATS
8
8
tags: messaging nats cli
9
9
categories:
10
10
- messaging
11
11
dates:
12
-
validation: 2024-04-09
12
+
validation: 2024-10_18
13
13
posted: 2023-01-20
14
14
---
15
15
@@ -18,7 +18,7 @@ The NATS CLI (`nats`) is the official NATS tool for managing your NATS resources
18
18
Check out the official [NATS CLI documentation](https://docs.nats.io/using-nats/nats-tools/nats_cli/) for installation instructions, examples and more.
19
19
20
20
<Messagetype="tip">
21
-
You can also configure Messaging and Queuing with the Terraform NATS Jetstream provider using our [dedicated tutorial](https://registry.terraform.io/providers/scaleway/scaleway/latest/docs/guides/mnq_with_nats_terraform_provider).
21
+
You can also configure Scaleway NATS with the Terraform NATS Jetstream provider using our [dedicated tutorial](https://registry.terraform.io/providers/scaleway/scaleway/latest/docs/guides/mnq_with_nats_terraform_provider).
22
22
</Message>
23
23
24
24
This page shows you how to get started with some basic actions via the NATS CLI.
@@ -27,7 +27,7 @@ This page shows you how to get started with some basic actions via the NATS CLI.
27
27
28
28
- A Scaleway account logged into the [console](https://console.scaleway.com)
29
29
-[Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
30
-
- A [NATS account](/serverless/messaging/how-to/get-started/#how-to-create-a-nats-account)
30
+
- A Scaleway [NATS account](/serverless/messaging/how-to/get-started/#how-to-create-a-nats-account)
31
31
- NATS [credentials](/serverless/messaging/how-to/create-credentials/) downloaded to your machine
32
32
33
33
## Installing the NATS CLI
@@ -36,7 +36,7 @@ Follow instructions from the [official NATS documentation](https://docs.nats.io/
36
36
37
37
## Define a context
38
38
39
-
To simplify your interactions with NATS hosted on Scaleway Messaging and Queuing, we recommend that you use [contexts](https://docs.nats.io/using-nats/nats-tools/nats_cli#nats-contexts). A context is a named configuration that stores the settings (such as credentials, URLs and certificates) required to connect to NATS. By creating a context, you won't need to specify your server and credentials with each new request.
39
+
To simplify your interactions with NATS hosted on Scaleway, we recommend that you use [contexts](https://docs.nats.io/using-nats/nats-tools/nats_cli#nats-contexts). A context is a named configuration that stores the settings (such as credentials, URLs and certificates) required to connect to NATS. By creating a context, you won't need to specify your server and credentials with each new request.
40
40
41
41
### Create a context
42
42
@@ -62,7 +62,7 @@ To create a [stream](/serverless/messaging/concepts/#stream), use the command `n
62
62
63
63
<Messagetype="important">
64
64
Bear in mind that:
65
-
- Scaleway Messaging and Queuing does not support in-memory streams: choose `File` as storage backend.
65
+
- Scaleway NATS does not support in-memory streams: choose `File` as storage backend.
66
66
- Some [system limits](/serverless/messaging/reference-content/limitations/) may apply by default.
67
67
- If you choose a `Retention Policy` other than `Work Queue` you will be billed for the messages stored and retained.
0 commit comments