Skip to content

Polish docs. #330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 19, 2022
Merged

Polish docs. #330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 6 additions & 11 deletions docs/src/main/asciidoc/s3.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[#spring-cloud-aws-s3]
== Spring Cloud AWS S3
== S3 Integration

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

=== IAM Permissions
red

Following IAM permissions are required by Spring Cloud AWS:

[cols="2"]
[cols="2,1"]
|===
| Downloading files
| `s3:GetObject`

| Searching files
| `s3:ListObjects`

| Uploading files
| `s3:PutObject`
| Downloading files | `s3:GetObject`
| Searching files | `s3:ListObjects`
| Uploading files | `s3:PutObject`
|===

Sample IAM policy granting access to `spring-cloud-aws-demo` bucket:
Expand Down
24 changes: 7 additions & 17 deletions docs/src/main/asciidoc/sns.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[#spring-cloud-aws-sns]
== Spring Cloud AWS SNS
== SNS Integration

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

==== IAM Permissions
=== IAM Permissions
Following IAM permissions are required by Spring Cloud AWS:

[cols="2"]
[cols="2,1"]
|===
| To publish notification to topic
| `sns:Publish`

| To publish notification you will also need
| `sns:ListTopics`

| To use Annotation-driven HTTP notification endpoint
| `sns:ConfirmSubscription`

| For resolving topic name to ARN
| `sns:CreateTopic`



| To publish notification to topic | `sns:Publish`
| To publish notification you will also need | `sns:ListTopics`
| To use Annotation-driven HTTP notification endpoint | `sns:ConfirmSubscription`
| For resolving topic name to ARN | `sns:CreateTopic`
|===

Sample IAM policy granting access to SNS:
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/spring-cloud-aws.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ It also simplifies creating any non-integrated AWS SDK client by auto-configurin
That being said, it is perfectly valid option to use AWS SDK without using Spring Cloud AWS.

[TIP]
----
====
Note, that Spring provides support for other AWS services in following projects:

* https://github.com/spring-cloud/spring-cloud-stream-binder-aws-kinesis[Spring Cloud Stream Binder AWS Kinesis]
* https://github.com/spring-cloud/spring-cloud-config[Spring Cloud Config Server] supports AWS Parameter Store and Secrets Manager
* https://github.com/spring-projects/spring-integration-aws[Spring Integration for AWS]
----
====

== Getting Started

Expand Down