AWS Query
CertifiedQuery CloudWatch metrics
AWS Query
Query CloudWatch metrics
Fetches metric statistics over a rolling window using GetMetricStatistics. Uses current time as end, start = end - window. Results are sorted by timestamp.
type: io.kestra.plugin.aws.cloudwatch.QueryExamples
Query CPU utilization over the last 5 minutes
id: aws_cloudwatch_query
namespace: company.team
tasks:
- id: query
type: io.kestra.plugin.aws.cloudwatch.Query
accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
secretKeyId: "{{ secret('AWS_SECRET_KEY_ID') }}"
region: "us-east-1"
namespace: "AWS/EC2"
metricName: "CPUUtilization"
statistic: "Average"
periodSeconds: 60
window: PT5M
dimensions:
- name: "InstanceId"
value: "i-0abcd1234ef567890"
Properties
metricName *Requiredstring
Metric name
Name of the metric to retrieve.
accessKeyId string
Access Key Id in order to connect to AWS
If no credentials are defined, we will use the default credentials provider chain to fetch credentials.
compatibilityMode booleanstring
Enable compatibility mode
Use it to connect to S3 bucket with S3 compatible services that don't support the new transport client.
dimensions array
Dimensions
Optional dimension filters applied to the metric.
io.kestra.plugin.aws.cloudwatch.Query-DimensionKV
Dimension name
Dimension value
endpointOverride string
The endpoint with which the SDK should communicate
This property allows you to use a different S3 compatible storage backend.
forcePathStyle booleanstring
Force path style access
Must only be used when compatibilityMode is enabled.
namespace string
Namespace
Metric namespace; required for most metrics.
periodSeconds integerstring
60Period seconds
Granularity for aggregation; default 60 seconds.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
region string
AWS region with which the SDK should communicate
secretKeyId string
Secret Key Id in order to connect to AWS
If no credentials are defined, we will use the default credentials provider chain to fetch credentials.
sessionToken string
AWS session token, retrieved from an AWS token service, used for authenticating that this user has received temporary permissions to access a given resource
If no credentials are defined, we will use the default credentials provider chain to fetch credentials.
statistic string
AverageStatistic
Statistic to return (Average, Sum, Maximum, Minimum, SampleCount); default Average.
stsEndpointOverride string
The AWS STS endpoint with which the SDKClient should communicate
stsRoleArn string
AWS STS Role
The Amazon Resource Name (ARN) of the role to assume. If set the task will use the StsAssumeRoleCredentialsProvider. If no credentials are defined, we will use the default credentials provider chain to fetch credentials.
stsRoleExternalId string
AWS STS External Id
A unique identifier that might be required when you assume a role in another account. This property is only used when an stsRoleArn is defined.
stsRoleSessionDuration string
PT15MAWS STS Session duration
The duration of the role session (default: 15 minutes, i.e., PT15M). This property is only used when an stsRoleArn is defined.
stsRoleSessionName string
AWS STS Session name
This property is only used when an stsRoleArn is defined.
window string
PT5MWindow
Lookback duration from now, e.g., PT5M; default 5 minutes.
Outputs
count integer
Datapoint count
Number of datapoints returned after sorting.
series array
Series
List of datapoints as maps, sorted by timestamp.
