{% include youtubePlayer.html id="f5ZXELy49Tc" %}
With this API you can expose your AWS Cloudwatch dashboard to people that don't have an IAM user through a pre-signed private url.
To signup for the API, get your API key on RapidApi.
To give the API access to your cloudwatch dashboard, an IAM role needs to be created that the API can use to read your dashboards. The arn of this role should be passed to this parameter. For more info on Providing access to AWS Accounts owned by Third Parties, see the AWS documentation
example : arn:aws:iam::111111111111:role/cloudWatchDashAccess
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"cloudwatch:Describe*",
"cloudwatch:Get*",
"logs:Get*",
"logs:FilterLogEvents"
],
"Effect": "Allow",
"Resource": "*"
}
]
}
{% include youtubePlayer.html id="9a6BPaRnaL0" %}
When you grant our API access to your IAM role, an external ID is created that our API will use to assume the role. For more info on using an External ID When Granting Access to Your AWS Resources to a Third Party see the AWS documentation.
The account ID that needs to be granted access to your role is 956353661285 .
example : A1b11ABBAaB
The region in which the dashboard that you want to expose is defined in.
example : us-east-1
The name of the Cloudwatch Dashboard that you want to expose.
example : ELBDashboard
The unit for the update frequency.
Valid values are : month, week, day, hour, minute
Whenever a request is made to the api for a specific dashboard, a check is done if the last update of the dashboard was longer than ( updatefrequency * updatefrequencyunit ) ago. If so, the dashboard is refreshed.
example : hour
The update frequency.
The number of units specified in the parameter updatefrequencyunit that determine if the dashboard should be refreshed.
example : 1
If this parameter is set to true, an update of the dashboard is done, independent of the updatefrequency and updatefrequencyunit.
example : true
The name of the company to be displayed on the Dashboard
example : ACME Inc
The link to be used when clicking the company on the Dashboard
example : https://rapidapi.com/quodlibet/api/publiccloudwatchdashboard
The text to be used for the info link on the dashboard
example : more info
The link to be used when clicking the info text on the dashboard
example : https://rapidapi.com/quodlibet/api/publiccloudwatchdashboard
The first of the three time periods each metric on the dashboard is displayed for.
Valid values are : hour, day, week, month
Default value : hour
example : hour
The second of the three time periods each metric on the dashboard is displayed for.
Valid values are : hour, day, week, month
Default value : day
example : hour
The second of the three time periods each metric on the dashboard is displayed for.
Valid values are : hour, day, week, month
Default value : week
example : hour
{
"dashboardUrl": "https://publiccwdashboard.s3.us-east-2.amazonaws.com/eu-west-1/1925046479/Dashboardname/dashboard.html?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20191201T113328Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604799&X-Amz-Credential=AKIA55KY6ZFS6CXLNEVR%2F20191201%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=0ee2baa1bd1638db6a9c8d571244caafb743258e3c811e71d8c4ad2d26f6d3fe",
"status": 200,
"messages": [
{
"message": "Dashboard is being updated, it will be available in a few seconds.",
"type": "info"
},
{
"message": "The Dashboard Url will be valid until Sun Dec 08 11:33:28 UTC 2019",
"type": "info"
}
]
}