AWS opensearch-service documentation change
Summary
Added instructions for creating IAM role if missing and clarified SigV4 authentication requirement for indexing data
Security assessment
The change adds explicit guidance about AWS Signature Version 4 authentication, which improves security documentation but doesn't address a specific vulnerability
Diff
diff --git a/opensearch-service/latest/developerguide/gsg-serverless-cli.md b/opensearch-service/latest/developerguide/gsg-serverless-cli.md index afc99c650..9b309abf1 100644 --- a//opensearch-service/latest/developerguide/gsg-serverless-cli.md +++ b//opensearch-service/latest/developerguide/gsg-serverless-cli.md @@ -67 +67,7 @@ To start, create an AWS Identity and Access Management policy with the minimum r - 2. Attach `TutorialPolicy` to the IAM role who will index and search data in the collection. In this example, the role is named `TutorialRole`: + 2. Attach `TutorialPolicy` to the IAM role who will index and search data in the collection. In this example, the role is named `TutorialRole`. + +Before attaching the policy, create the `TutorialRole` if it doesn't already exist: + + aws iam create-role \ + --role-name TutorialRole \ + --assume-role-policy-document '{"Version": "2012-10-17","Statement": [{"Effect": "Allow","Principal": {"AWS": "arn:aws:iam::123456789012:root"},"Action": "sts:AssumeRole"}]}' @@ -231 +237 @@ The collection endpoint isn't available until the collection status changes to ` - 8. Use an HTTP tool such as [Postman](https://www.getpostman.com/) or curl to index data into the _books_ collection. The following example creates an index called _books-index_ and adds a single document. + 8. Use an HTTP tool such as [Postman](https://www.getpostman.com/) or curl to index data into the _books_ collection. The following example creates an index called _books-index_ and adds a single document. OpenSearch Serverless endpoints require AWS Signature Version 4 (SigV4) authentication. If you use curl, use the `--aws-sigv4` option or a tool like `awscurl` to sign your requests.