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

Add CLI examples for CloudWatch Synthetics #8977

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

ashishbharadwajm
Copy link

Issue #, if available:

Description of changes:

Adding example CLI commands for Amazon CloudWatch Synthetics: https://docs.aws.amazon.com/cli/latest/reference/synthetics/

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@elysahall elysahall self-requested a review October 21, 2024 16:23
@elysahall elysahall self-assigned this Oct 21, 2024
@elysahall elysahall added the documentation This is a problem with documentation. label Oct 21, 2024
@elysahall elysahall added the pr:work-in-progress This PR is a draft and needs further work. label Oct 31, 2024
Copy link
Collaborator

@elysahall elysahall left a comment

Choose a reason for hiding this comment

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

Hi Ashish,
Thank you for your command example submission. I've finished reviewing your pull request. Please fix these formatting issues and push your updated commit. Thanks!

@@ -0,0 +1,9 @@
**To Associate a canary with a group**

The following ``associate-resource`` example associates a canary with group named `demo_group``. If the command succeeds, no output is returned. ::
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The following ``associate-resource`` example associates a canary with group named `demo_group``. If the command succeeds, no output is returned. ::
The following ``associate-resource`` example associates a canary with the group named ``demo_group``. ::


aws synthetics associate-resource \
--group-identifier demo_group \
--resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
--resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary
--resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary
This command produces no output.

@@ -0,0 +1,11 @@
**To Associate a canary with a group**

The following ``associate-resource`` example associates a canary with group named `demo_group``.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The following ``associate-resource`` example associates a canary with group named `demo_group``.
The following ``associate-resource`` example associates a canary with a group named ``demo_group``. ::

@@ -0,0 +1,11 @@
**To Associate a canary with a group**
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
**To Associate a canary with a group**
**To associate a canary with a group**

@@ -0,0 +1,48 @@
**To Create a canary**
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
**To Create a canary**
**To create a canary**

@@ -0,0 +1,21 @@
**Example 1: To Remove a tag from the canary**

The following ``untag-resource`` example removes a tag from the canary named ``demo_canary``.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The following ``untag-resource`` example removes a tag from the canary named ``demo_canary``.
The following ``untag-resource`` example removes a tag from the canary named ``demo_canary``. ::


This command produces no output.

**Example 2: To Remove a tag from the group**
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
**Example 2: To Remove a tag from the group**
**Example 2: To remove a tag from the group**


**Example 2: To Remove a tag from the group**

The following ``untag-resource`` example assigns a removes a tag from the group named ``demo_group``.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The following ``untag-resource`` example assigns a removes a tag from the group named ``demo_group``.
The following ``untag-resource`` example assigns a removes a tag from the group named ``demo_group``. ::

@@ -0,0 +1,11 @@
**To Update a canary**
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
**To Update a canary**
**To update a canary**

@@ -0,0 +1,11 @@
**To Update a canary**

The following ``update-canary`` example updates the configuration of a canary named ``demo_canary``.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The following ``update-canary`` example updates the configuration of a canary named ``demo_canary``.
The following ``update-canary`` example updates the configuration of a canary named ``demo_canary``. ::

@ashishdhingra
Copy link
Contributor

@elysahall I guess you tagged wrong person. Please reach out to @ashishbharadwajm.

@ashishbharadwajm
Copy link
Author

Hi Ashish, Thank you for your command example submission. I've finished reviewing your pull request. Please fix these formatting issues and push your updated commit. Thanks!

Thank you for the review. Published the new commit with the suggested changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation. pr:work-in-progress This PR is a draft and needs further work.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants