From d45bf9b8b5e5baf956ddec7e7e3fa952c7b1c769 Mon Sep 17 00:00:00 2001 From: Maciej Walkowiak Date: Tue, 19 Apr 2022 14:29:03 +0200 Subject: [PATCH] Polish docs. --- docs/src/main/asciidoc/s3.adoc | 17 +++++--------- docs/src/main/asciidoc/sns.adoc | 24 ++++++-------------- docs/src/main/asciidoc/spring-cloud-aws.adoc | 4 ++-- 3 files changed, 15 insertions(+), 30 deletions(-) diff --git a/docs/src/main/asciidoc/s3.adoc b/docs/src/main/asciidoc/s3.adoc index ceec7e874..8a33e2660 100644 --- a/docs/src/main/asciidoc/s3.adoc +++ b/docs/src/main/asciidoc/s3.adoc @@ -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. @@ -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: diff --git a/docs/src/main/asciidoc/sns.adoc b/docs/src/main/asciidoc/sns.adoc index a40d36489..b9c0106cd 100644 --- a/docs/src/main/asciidoc/sns.adoc +++ b/docs/src/main/asciidoc/sns.adoc @@ -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. @@ -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: diff --git a/docs/src/main/asciidoc/spring-cloud-aws.adoc b/docs/src/main/asciidoc/spring-cloud-aws.adoc index 333ae76dd..60e0fbf59 100644 --- a/docs/src/main/asciidoc/spring-cloud-aws.adoc +++ b/docs/src/main/asciidoc/spring-cloud-aws.adoc @@ -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