Skip to content
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.

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

AWS connectors: align client setup docs #2038

Merged
merged 4 commits into from
Dec 12, 2019
Merged

Conversation

ennru
Copy link
Member

@ennru ennru commented Nov 28, 2019

Purpose

Align the docs how the AWS SDK clients are created using Akka HTTP as an underlying HTTP client.

References

References #2014

Changes

  • new docs page "AWS retry configuration"
  • Use Akka HTTP even for AWS Lambda and Kinesis
  • Show Akka HTTP client setup in all examples
  • Show more imports in examples
  • Use Akka 2.6.0 for cross builds

@ennru
Copy link
Member Author

ennru commented Nov 28, 2019

@gabfssilva @regiskuckaertz could you have a look and check if I got it right?

@gabfssilva
Copy link
Contributor

@gabfssilva @regiskuckaertz could you have a look and check if I got it right?

LGTM

@@ -296,7 +310,7 @@ object Dependencies {
ExclusionRule("software.amazon.awssdk", "netty-nio-client")
),
"org.mockito" % "mockito-core" % mockitoVersion % Test // MIT
)
) ++ JacksonDatabindDependencies

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

woops, good catch 🤭

@regiskuckaertz
Copy link

👍 Looks great!

Copy link
Member

@seglo seglo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Just some minor things to consider.

docs/src/main/paradox/awslambda.md Outdated Show resolved Hide resolved
import software.amazon.awssdk.auth.credentials.{AwsBasicCredentials, StaticCredentialsProvider}
import software.amazon.awssdk.services.lambda.LambdaAsyncClient

val credentials = AwsBasicCredentials.create("x", "x")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[minor] I know isn't new code, but maybe we should add a comment link to best practices for AWS key management so users don't just copy and paste this and hardcode credentials. I found this resource: https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html

docs/src/main/paradox/awslambda.md Outdated Show resolved Hide resolved
docs/src/main/paradox/kinesis.md Outdated Show resolved Hide resolved
docs/src/main/paradox/sns.md Outdated Show resolved Hide resolved
docs/src/main/paradox/sqs.md Outdated Show resolved Hide resolved
@ennru
Copy link
Member Author

ennru commented Dec 12, 2019

Good point about the credentials, @seglo
I pushed this further and made it a "Shared AWS client configuraion" doc page instead.

@ennru ennru merged commit a0128cd into akka:master Dec 12, 2019
@ennru ennru deleted the aws-retry-docs branch December 12, 2019 08:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants