Add CLI examples for CloudWatch Logs #8995
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
elysahall
added
documentation
|
|
||
| aws logs associate-kms-key \ | ||
| --log-group-name demo-log-group \ | ||
| --kms-key-id ``KMS_KEY_ID_ARN`` |
There was a problem hiding this comment.
Security software installed on my system blocks any push that contain sensitive info like KMS Key ID (even an example one). Hence, replaced it with KMS_KEY_ID_ARN.
elysahall
suggested changes
Nov 12, 2024
|
|
||
| aws logs associate-kms-key \ | ||
| --log-group-name demo-log-group \ | ||
| --kms-key-id ``KMS_KEY_ID_ARN`` |
There was a problem hiding this comment.
Suggested change
| --kms-key-id ``KMS_KEY_ID_ARN`` | |
| --kms-key-id 1234abcd-12ab-34cd-56ef-1234567890ab |
| @@ -0,0 +1,9 @@ | |||
| **To Associate a KMS key with the log group** | |||
There was a problem hiding this comment.
Suggested change
| **To Associate a KMS key with the log group** | |
| **To associate a KMS key with the log group** |
| @@ -0,0 +1,9 @@ | |||
| **To Associate a KMS key with the log group** | |||
|
|
|||
| The following ``associate-kms-key`` example associates KMS key with log group named ``demo-log-group``. If the command succeeds, no output is returned. :: | |||
There was a problem hiding this comment.
Suggested change
| The following ``associate-kms-key`` example associates KMS key with log group named ``demo-log-group``. If the command succeeds, no output is returned. :: | |
| The following ``associate-kms-key`` example associates KMS key with log group named ``demo-log-group``. :: |
| aws logs associate-kms-key \ | ||
| --log-group-name demo-log-group \ | ||
| --kms-key-id ``KMS_KEY_ID_ARN`` | ||
|
|
There was a problem hiding this comment.
Suggested change
| This command produces no output. | |
There was a problem hiding this comment.
Updated with the standard line after the example command as per the style guide:
https://aws.github.io/aws-cli/docs_styleguide.html#output
| @@ -0,0 +1,8 @@ | |||
| **To Cancel an export task** | |||
There was a problem hiding this comment.
Suggested change
| **To Cancel an export task** | |
| **To cancel an export task** |
| @@ -0,0 +1,16 @@ | |||
| **To Create or update a query definition for CloudWatch Logs Insights** | |||
There was a problem hiding this comment.
Suggested change
| **To Create or update a query definition for CloudWatch Logs Insights** | |
| **To create or update a query definition for CloudWatch Logs Insights** |
| aws logs put-query-definition \ | ||
| --name DemoLogsQueries/Example \ | ||
| --log-group-names arn:aws:logs:us-east-1:123456789012:log-group:demo-log-group \ | ||
| --query-string "stats sum(packets) as packetsTransferred by srcAddr, dstAddr | sort packetsTransferred desc | limit 100" |
There was a problem hiding this comment.
Suggested change
| --query-string "stats sum(packets) as packetsTransferred by srcAddr, dstAddr | sort packetsTransferred desc | limit 100" | |
| --query-string 'stats sum(packets) as packetsTransferred by srcAddr, dstAddr | sort packetsTransferred desc | limit 100' |
| @@ -0,0 +1,16 @@ | |||
| **To Create or update a query definition for CloudWatch Logs Insights** | |||
|
|
|||
| The following ``put-query-definition`` example creates a query definition for CloudWatch Logs Insights. If the command succeeds, no output is returned. :: | |||
There was a problem hiding this comment.
Suggested change
| The following ``put-query-definition`` example creates a query definition for CloudWatch Logs Insights. If the command succeeds, no output is returned. :: | |
| The following ``put-query-definition`` example creates a query definition for CloudWatch Logs Insights. :: |
| @@ -0,0 +1,40 @@ | |||
| **To Create or update a resource policy** | |||
There was a problem hiding this comment.
Suggested change
| **To Create or update a resource policy** | |
| **To create or update a resource policy** |
| --policy-name AllowEventBridgeEventsToCWLogs \ | ||
| --policy-document file://policy.json | ||
|
|
||
| The file ``policy.json`` is a JSON document in the current folder. |
There was a problem hiding this comment.
Suggested change
| The file ``policy.json`` is a JSON document in the current folder. | |
| Contents of ``policy.json``:: |
elysahall
suggested changes
Nov 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
Description of changes:
Add example CLI commands for Amazon CloudWatch Logs: https://docs.aws.amazon.com/cli/latest/reference/logs/
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.