AWS AmazonCloudWatch documentation change
Summary
Updated service name references from 'Kinesis Data Streams' to 'Amazon Kinesis Data Streams' for consistency. Updated links in Lambda and Firehose sections.
Security assessment
Changes are purely branding/nomenclature updates and link corrections. No security vulnerabilities, configurations, or features are mentioned or modified. The throttling mitigation advice remains unchanged.
Diff
diff --git a/AmazonCloudWatch/latest/logs/SubscriptionFilters.md b/AmazonCloudWatch/latest/logs/SubscriptionFilters.md index 75f1b6b4c..5a585fd99 100644 --- a//AmazonCloudWatch/latest/logs/SubscriptionFilters.md +++ b//AmazonCloudWatch/latest/logs/SubscriptionFilters.md @@ -5 +5 @@ -Example 1: Subscription filters with Kinesis Data StreamsExample 2: Subscription filters with AWS LambdaExample 3: Subscription filters with Amazon Data FirehoseExample 4: Subscription filters with Amazon OpenSearch Service +Example 1: Subscription filters with Amazon Kinesis Data StreamsExample 2: Subscription filters with AWS LambdaExample 3: Subscription filters with Amazon Data FirehoseExample 4: Subscription filters with Amazon OpenSearch Service @@ -9 +9 @@ Example 1: Subscription filters with Kinesis Data StreamsExample 2: Subscription -You can use a subscription filter with Amazon Kinesis Data Streams, AWS Lambda, Amazon Data Firehose, or Amazon OpenSearch Service. Logs sent to a service through a subscription filter are base64 encoded and compressed with the gzip format. If you are using centralized logs with your AWS Organizations, you can choose to emit the `@aws.account` and `@aws.region` system field to identify which data comes from which accounts and regions in your organization. This section provides examples you can follow to create a CloudWatch Logs subscription filter that sends log data to Firehose, Lambda, Kinesis Data Streams, and OpenSearch Service. +You can use a subscription filter with Amazon Kinesis Data Streams, AWS Lambda, Amazon Data Firehose, or Amazon OpenSearch Service. Logs sent to a service through a subscription filter are base64 encoded and compressed with the gzip format. If you are using centralized logs with your AWS Organizations, you can choose to emit the `@aws.account` and `@aws.region` system field to identify which data comes from which accounts and regions in your organization. This section provides examples you can follow to create a CloudWatch Logs subscription filter that sends log data to Firehose, Lambda, Amazon Kinesis Data Streams, and OpenSearch Service. @@ -17 +17 @@ If you want to search your log data, see [Filter and pattern syntax](https://doc - * Example 1: Subscription filters with Kinesis Data Streams + * Example 1: Subscription filters with Amazon Kinesis Data Streams @@ -28 +28 @@ If you want to search your log data, see [Filter and pattern syntax](https://doc -## Example 1: Subscription filters with Kinesis Data Streams +## Example 1: Subscription filters with Amazon Kinesis Data Streams @@ -30 +30 @@ If you want to search your log data, see [Filter and pattern syntax](https://doc -The following example associates a subscription filter with a log group containing AWS CloudTrail events. The subscription filter delivers every logged activity made by "Root" AWS credentials to a stream in Kinesis Data Streams called "RootAccess." For more information about how to send AWS CloudTrail events to CloudWatch Logs, see [Sending CloudTrail Events to CloudWatch Logs](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cw_send_ct_events.html) in the _AWS CloudTrail User Guide_. +The following example associates a subscription filter with a log group containing AWS CloudTrail events. The subscription filter delivers every logged activity made by "Root" AWS credentials to a stream in Amazon Kinesis Data Streams called "RootAccess." For more information about how to send AWS CloudTrail events to CloudWatch Logs, see [Sending CloudTrail Events to CloudWatch Logs](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cw_send_ct_events.html) in the _AWS CloudTrail User Guide_. @@ -44 +44 @@ To mitigate the risk of throttling, you can take the following steps: - * Use the on-demand capacity mode for your stream in Kinesis Data Streams. On-demand mode instantly accommodates your workloads as they ramp up or down. More information about on-demand capacity mode, see [ On-demand mode](https://docs.aws.amazon.com/streams/latest/dev/how-do-i-size-a-stream.html#ondemandmode). + * Use the on-demand capacity mode for your stream in Amazon Kinesis Data Streams. On-demand mode instantly accommodates your workloads as they ramp up or down. More information about on-demand capacity mode, see [ On-demand mode](https://docs.aws.amazon.com/streams/latest/dev/how-do-i-size-a-stream.html#ondemandmode). @@ -46 +46 @@ To mitigate the risk of throttling, you can take the following steps: - * Restrict your CloudWatch subscription filter pattern to match the capacity of your stream in Kinesis Data Streams. If you are sending too much data to the stream, you might need to reduce the filter size or adjust the filter criteria. + * Restrict your CloudWatch subscription filter pattern to match the capacity of your stream in Amazon Kinesis Data Streams. If you are sending too much data to the stream, you might need to reduce the filter size or adjust the filter criteria. @@ -51 +51 @@ To mitigate the risk of throttling, you can take the following steps: -###### To create a subscription filter for Kinesis Data Streams +###### To create a subscription filter for Amazon Kinesis Data Streams @@ -57 +57 @@ To mitigate the risk of throttling, you can take the following steps: - 2. Wait until the stream becomes Active (this might take a minute or two). You can use the following Kinesis Data Streams [describe-stream](https://docs.aws.amazon.com/cli/latest/reference/kinesis/describe-stream.html) command to check the **StreamDescription.StreamStatus** property. In addition, note the **StreamDescription.StreamARN** value, as you will need it in a later step: + 2. Wait until the stream becomes Active (this might take a minute or two). You can use the following Amazon Kinesis Data Streams [describe-stream](https://docs.aws.amazon.com/cli/latest/reference/kinesis/describe-stream.html) command to check the **StreamDescription.StreamStatus** property. In addition, note the **StreamDescription.StreamARN** value, as you will need it in a later step: @@ -154 +154 @@ The following is an example of the output. - 8. After you set up the subscription filter, CloudWatch Logs forwards all the incoming log events that match the filter pattern to your stream. You can verify that this is happening by grabbing a Kinesis Data Streams shard iterator and using the Kinesis Data Streams get-records command to fetch some Kinesis Data Streams records: + 8. After you set up the subscription filter, CloudWatch Logs forwards all the incoming log events that match the filter pattern to your stream. You can verify that this is happening by grabbing a Amazon Kinesis Data Streams shard iterator and using the Amazon Kinesis Data Streams get-records command to fetch some Amazon Kinesis Data Streams records: @@ -165 +165 @@ The following is an example of the output. -Note that you might need to make this call a few times before Kinesis Data Streams starts to return data. +Note that you might need to make this call a few times before Amazon Kinesis Data Streams starts to return data. @@ -167 +167 @@ Note that you might need to make this call a few times before Kinesis Data Strea -You should expect to see a response with an array of records. The **Data** attribute in a Kinesis Data Streams record is base64 encoded and compressed with the gzip format. You can examine the raw data from the command line using the following Unix commands: +You should expect to see a response with an array of records. The **Data** attribute in a Amazon Kinesis Data Streams record is base64 encoded and compressed with the gzip format. You can examine the raw data from the command line using the following Unix commands: @@ -225 +225 @@ The list of subscription filter names that matched with the originating log data -Data messages will use the "DATA_MESSAGE" type. Sometimes CloudWatch Logs may emit Kinesis Data Streams records with a "CONTROL_MESSAGE" type, mainly for checking if the destination is reachable. +Data messages will use the "DATA_MESSAGE" type. Sometimes CloudWatch Logs may emit Amazon Kinesis Data Streams records with a "CONTROL_MESSAGE" type, mainly for checking if the destination is reachable. @@ -247 +247 @@ Before you create the Lambda function, calculate the volume of log data that wil -Ensure that you have set up the Lambda execution role. For more information, see [Step 2.2: Create an IAM Role (execution role)](https://docs.aws.amazon.com/lambda/latest/dg/walkthrough-custom-events-create-test-function.html) in the _AWS Lambda Developer Guide_. +Ensure that you have set up the Lambda execution role. For more information, see [Step 2.2: Create an IAM Role (execution role)](https://docs.aws.amazon.com/lambda/latest/dg/lambda-intro-execution-role.html) in the _AWS Lambda Developer Guide_. @@ -370 +370 @@ The actual log data, represented as an array of log event records. The "id" prop -In this example, you'll create a CloudWatch Logs subscription that sends any incoming log events that match your defined filters to your Amazon Data Firehose delivery stream. Data sent from CloudWatch Logs to Amazon Data Firehose is already compressed with gzip level 6 compression, so you do not need to use compression within your Firehose delivery stream. You can then use the decompression feature in Firehose to automatically decompress the logs. For more information, see [ Send CloudWatch Logs to Firehose](https://docs.aws.amazon.com/firehose/latest/dev/writing-with-cloudwatch-logs.html). +In this example, you'll create a CloudWatch Logs subscription that sends any incoming log events that match your defined filters to your Amazon Data Firehose delivery stream. Data sent from CloudWatch Logs to Amazon Data Firehose is already compressed with gzip level 6 compression, so you do not need to use compression within your Firehose delivery stream. You can then use the decompression feature in Firehose to automatically decompress the logs. For more information, see [ Send CloudWatch Logs to Firehose](https://docs.aws.amazon.com/logs/SubscriptionFilters.html#FirehoseExample).