AWS opensearch-service documentation change
Summary
Multiple ARN syntax fixes, updated documentation links, and example value standardization
Security assessment
Changes focus on documentation consistency (placeholder formatting, example values) and updated internal links rather than addressing security issues
Diff
diff --git a/opensearch-service/latest/developerguide/configure-client-kinesis.md b/opensearch-service/latest/developerguide/configure-client-kinesis.md index 9884c534a..f41c3b397 100644 --- a/opensearch-service/latest/developerguide/configure-client-kinesis.md +++ b/opensearch-service/latest/developerguide/configure-client-kinesis.md @@ -9 +9 @@ Connectivity to Amazon Kinesis Data StreamsStep 1: Configure the pipeline roleSt -You can use an OpenSearch Ingestion pipeline to stream data from Amazon Kinesis Data Streams to Amazon OpenSearch Service domains and OpenSearch Serverless collections. The pipeline pulls records from Amazon Kinesis and sends them to OpenSearch, and automatically generates indexes based on the stream name and current date. +You can use the [Kinesis](https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/sources/kinesis/) plugin to stream data from Amazon Kinesis Data Streams to Amazon OpenSearch Service domains and OpenSearch Serverless collections. The pipeline pulls records from Amazon Kinesis and sends them to OpenSearch, and automatically generates indexes based on the stream name and current date. @@ -35 +35 @@ The following sample domain access policy allows the pipeline role, which you cr - "AWS": "arn:aws:iam::{account-id}:role/{pipeline-role}" + "AWS": "arn:aws:iam::account-id:role/pipeline-role" @@ -42 +42 @@ The following sample domain access policy allows the pipeline role, which you cr - "arn:aws:es:{region}:{account-id}:domain/{domain-name}" + "arn:aws:es:region:account-id:domain/domain-name" @@ -48 +48 @@ The following sample domain access policy allows the pipeline role, which you cr -To create an IAM role with the correct permissions to access write data to the collection or domain, see [Required permissions for domains](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/osis-get-started.html#osis-get-started-permissions) and [Required permissions for collections](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/osis-serverless-get-started.html#osis-serverless-get-started-permissions). +To create an IAM role with the correct permissions to access write data to the collection or domain, see [Setting up roles and users in Amazon OpenSearch Ingestion](./pipeline-security-overview.html). @@ -79 +79 @@ The following permission is needed to write to an Amazon S3 bucket, domain, and - "arn:aws:kinesis:{region}:{account-id}:stream/{stream-name}" + "arn:aws:kinesis:region:account-id:stream/stream-name" @@ -98 +98 @@ If server-side encryption is enabled for streams, the following KMS policy will - "Resource": "arn:aws:kms:{region}:{account-id}:key/{key-id}" + "Resource": "arn:aws:kms:region:account-id:key/key-id" @@ -111 +111 @@ In order for a pipeline to write data to a domain, the domain must have a [domai - "AWS": "arn:aws:iam::{account-id}:role/{pipeline-role}" + "AWS": "arn:aws:iam::account-id:role/pipeline-role" @@ -114 +114 @@ In order for a pipeline to write data to a domain, the domain must have a [domai - "Resource": "arn:aws:es:{region}:{account-id}:domain/{domain-name}/*" + "Resource": "arn:aws:es:region:account-id:domain/domain-name/*" @@ -151,2 +151,2 @@ You can also migrate data from Amazon Kinesis to an OpenSearch Serverless VPC co - sts_role_arn: "arn:aws:iam::{account-id}:role/{pipeline-role}" - region: "{region}" + sts_role_arn: "arn:aws:iam::account-id:role/pipeline-role" + region: "us-east-1" @@ -157 +157 @@ You can also migrate data from Amazon Kinesis to an OpenSearch Serverless VPC co - index: "index_${getMetadata(\"{stream_name}\")}" + index: "index_${getMetadata(\"stream-name\")}" @@ -164 +164 @@ You can also migrate data from Amazon Kinesis to an OpenSearch Serverless VPC co - bucket: "{dlq-bucket-name}" + bucket: "dlq-bucket-name" @@ -166 +166 @@ You can also migrate data from Amazon Kinesis to an OpenSearch Serverless VPC co - sts_role_arn: "arn:aws:iam::{account-id}:role/{pipeline-role}" + sts_role_arn: "arn:aws:iam::account-id:role/pipeline-role"