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

docs/elasticache_replication_group: Add missing fields #2638

Merged
merged 1 commit into from
Dec 12, 2017

Conversation

radeksimko
Copy link
Member

Forgotten in #2090

@radeksimko radeksimko added the documentation Introduces or discusses updates to documentation. label Dec 12, 2017
Copy link
Contributor

@tombuildsstuff tombuildsstuff left a comment

Choose a reason for hiding this comment

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

otherwise LGTM 👍

* `engine` - (Optional) The name of the cache engine to be used for the clusters in this replication group. e.g. `redis`
* `at_rest_encryption_enabled` - (Optional) Whether to enable encryption at rest.
* `transit_encryption_enabled` - (Optional) Whether to enable encryption in transit.
* `auth_token` - (Optional) The password used to access a password protected server. Can be specified only if `transit_encryption_enabled = true`.
Copy link
Contributor

Choose a reason for hiding this comment

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

auth_token - (Optional) The password used to access a password protected server.

feels like that’d be better as “The auth token used to access an encrypted server”?

Copy link
Member Author

Choose a reason for hiding this comment

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

In the context of Redis (which is currently the only engine supporting this) it's called password: https://redis.io/commands/auth

AFAIK the transit encryption is unrelated to the auth token - you can encrypt it whether or not you use auth_token.

I assume the encryption in transit was added by AWS so that the password isn't transmitted in plaintext over the wire.

btw. the description matches description from the API reference: http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateReplicationGroup.html

Copy link
Contributor

Choose a reason for hiding this comment

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

👍 seems sensible

@radeksimko radeksimko merged commit cb45e68 into master Dec 12, 2017
@radeksimko radeksimko deleted the docs-elasticache-rg branch December 12, 2017 10:27
@ghost
Copy link

ghost commented Apr 10, 2020

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!

@ghost ghost locked and limited conversation to collaborators Apr 10, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Introduces or discusses updates to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants