PluginsPlugin AwsCloudwatch

Query CloudWatch metrics.

yaml
type: "io.kestra.plugin.aws.cloudwatch.query"

Query CPU utilization over the last 5 minutes

yaml
id: "query"
type: "io.kestra.plugin.aws.cloudwatch.query"
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

The metric name to query

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.

Enable compatibility mode.

Use it to connect to S3 bucket with S3 compatible services that don't support the new transport client.

Dimensions to filter the metric

The endpoint with which the SDK should communicate.

This property allows you to use a different S3 compatible storage backend.

Force path style access.

Must only be used when compatibilityMode is enabled.

CloudWatch namespace (optional, required for metric-based queries)

Default 60

Period in seconds for data aggregation

AWS region with which the SDK should communicate.

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.

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.

Default Average

Statistic type to retrieve

e.g., Average, Sum, Maximum, Minimum, SampleCount

The AWS STS endpoint with which the SDKClient should communicate.

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.

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.

Default PT15M
Format duration

AWS 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.

AWS STS Session name.

This property is only used when an stsRoleArn is defined.

Default PT5M
Format duration

Time window to query

Duration looking back from now, e.g., PT5M for 5 minutes

Total number of datapoints returned

SubType object

Time series data with timestamps and values

Dimension name

Dimension value