@tinystacks/ops-aws-core-widgets
v0.0.27
Published
This package contains a list of core AWS widgets.
Downloads
16
Readme
Overview
This package contains a list of core AWS widgets.
Widgets
|Name|Description| |---------|---------| |CloudWatch Logs|Renders a widget containing logs from a CloudWatchLogs log group or log stream. |CloudWatch Metric Graph|Renders a widget containing graphs populated by one or many CloudWatch metrics. |ECS Info|Renders a widget containing information about an ECS Service. |ECS Deployments|Renders a widget containing information about an ECS Service's current deployments.
CloudWatch Logs
Renders a widget containing logs from a CloudWatchLogs log group or log stream.
|Parameter|Required|Type|Description| |---------|---------|---------|---------| |displayName|Yes|string|Display name of widget. |providers|Yes|array| A list of providers. The first provider must be of type AwsCredentialsProvider or results will not be retrieved. |region|Yes|string|The AWS region to request logs from. |logGroupName|Yes|String|The AWS LogGroup name to request logs from. |logStreamName|No|String|The AWS LogStream name to request logs from. If this field is not specified, this widget will retrieve all log events in the LogGroup. |timeRange|No|RelativeTime or AbsoluteTimeRange|The time range in which to look for logs |showTimeRangeSelector|No|boolean|Whether to show the time range selector which supplies time-range overrides
CloudWatch Metric Graph
Renders a widget containing graphs populated by one or many CloudWatch metrics.
|Parameter|Required|Type|Description| |---------|---------|---------|---------| |displayName|Yes|string|Display name of widget. |providers|Yes|array| A list of providers. The first provider must be of type AwsCredentialsProvider or results will not be retrieved. |region|Yes|string|The AWS region to request logs from. |timeRange|No|RelativeTime or AbsoluteTimeRange|The time range in which to look for logs. |period|No|number|The period, in seconds, used to populate data from CloudWatch. |showTimeRangeSelector|No|boolean|Whether to show the time range selector which supplies time-range overrides.
ECS Info
Renders a widget containing information about an ECS Service.
|Parameter|Required|Type|Description| |---------|---------|---------|---------| |displayName|Yes|string|Display name of widget. |providers|Yes|array| A list of providers. The first provider must be of type AwsCredentialsProvider or results will not be retrieved. |region|Yes|string|The AWS region to request logs from. |clusterName|Yes|string|The name of the ECS Cluster. |serviceName|Yes|string|The name of the ECS Service.
ECS Deployments
Renders a widget containing information about an ECS Service's current deployments.
|Parameter|Required|Type|Description| |---------|---------|---------|---------| |displayName|Yes|string|Display name of widget. |providers|Yes|array| A list of providers. The first provider must be of type AwsCredentialsProvider or results will not be retrieved. |region|Yes|string|The AWS region the ECS Cluster is in. |clusterName|Yes|string|The name of the ECS Cluster. |serviceName|Yes|string|The name of the ECS Service.
Parameters
|Name|Description| |---------|---------| |AbsoluteTimeRange|Range of absolute time.| |RelativeTime|Time range defined relatively to current time.|
AbsoluteTimeRange
Range of absolute time.
|Parameter|Required|Type|Description| |---------|---------|---------|---------| |startTime|Yes|number|The beginning of the time range as UNIX time. |endTime|Yes|number|The end of the time range as UNIX time.
RelativeTime
Range of absolute time.
|Parameter|Required|Type|Description| |---------|---------|---------|---------| |time|Yes|number|A number expressing how many units of time ago to start looking. |unit|Yes|ns, ms, s, m, h, d, w, mo or yr|Units of time.