Skip to content

Commit 93fb3a8

Browse files
Polish docs. (#330)
1 parent 4d6e910 commit 93fb3a8

File tree

3 files changed

+15
-30
lines changed

3 files changed

+15
-30
lines changed

docs/src/main/asciidoc/s3.adoc

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[#spring-cloud-aws-s3]
2-
== Spring Cloud AWS S3
2+
== S3 Integration
33

44
https://aws.amazon.com/s3/[S3] allows storing files in a cloud.
55
A Spring Boot starter is provided to auto-configure the various S3 integration related components.
@@ -206,19 +206,14 @@ The Spring Boot Starter for S3 provides the following configuration options:
206206
|===
207207

208208
=== IAM Permissions
209-
red
209+
210210
Following IAM permissions are required by Spring Cloud AWS:
211211

212-
[cols="2"]
212+
[cols="2,1"]
213213
|===
214-
| Downloading files
215-
| `s3:GetObject`
216-
217-
| Searching files
218-
| `s3:ListObjects`
219-
220-
| Uploading files
221-
| `s3:PutObject`
214+
| Downloading files | `s3:GetObject`
215+
| Searching files | `s3:ListObjects`
216+
| Uploading files | `s3:PutObject`
222217
|===
223218

224219
Sample IAM policy granting access to `spring-cloud-aws-demo` bucket:

docs/src/main/asciidoc/sns.adoc

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[#spring-cloud-aws-sns]
2-
== Spring Cloud AWS SNS
2+
== SNS Integration
33

44
https://aws.amazon.com/sns/[SNS] is a pub/sub messaging service that allows clients to publish notifications to a particuluar topic.
55
A Spring Boot starter is provided to auto-configure SNS integration beans.
@@ -173,25 +173,15 @@ The Spring Boot Starter for SNS provides the following configuration options:
173173
| `spring.cloud.aws.sns.region` | Configures region used by `SnsClient`. | No | `eu-west-1`
174174
|===
175175

176-
==== IAM Permissions
176+
=== IAM Permissions
177177
Following IAM permissions are required by Spring Cloud AWS:
178178

179-
[cols="2"]
179+
[cols="2,1"]
180180
|===
181-
| To publish notification to topic
182-
| `sns:Publish`
183-
184-
| To publish notification you will also need
185-
| `sns:ListTopics`
186-
187-
| To use Annotation-driven HTTP notification endpoint
188-
| `sns:ConfirmSubscription`
189-
190-
| For resolving topic name to ARN
191-
| `sns:CreateTopic`
192-
193-
194-
181+
| To publish notification to topic | `sns:Publish`
182+
| To publish notification you will also need | `sns:ListTopics`
183+
| To use Annotation-driven HTTP notification endpoint | `sns:ConfirmSubscription`
184+
| For resolving topic name to ARN | `sns:CreateTopic`
195185
|===
196186

197187
Sample IAM policy granting access to SNS:

docs/src/main/asciidoc/spring-cloud-aws.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ It also simplifies creating any non-integrated AWS SDK client by auto-configurin
3030
That being said, it is perfectly valid option to use AWS SDK without using Spring Cloud AWS.
3131

3232
[TIP]
33-
----
33+
====
3434
Note, that Spring provides support for other AWS services in following projects:
3535
3636
* https://github.com/spring-cloud/spring-cloud-stream-binder-aws-kinesis[Spring Cloud Stream Binder AWS Kinesis]
3737
* https://github.com/spring-cloud/spring-cloud-config[Spring Cloud Config Server] supports AWS Parameter Store and Secrets Manager
3838
* https://github.com/spring-projects/spring-integration-aws[Spring Integration for AWS]
39-
----
39+
====
4040

4141
== Getting Started
4242

0 commit comments

Comments
 (0)