Push metrics to AWS CloudWatch.

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

Examples

Push custom metrics to CloudWatch

yaml
id: aws_cloudwatch_push
namespace: company.team

tasks:
  - id: push_metric
    type: io.kestra.plugin.aws.cloudwatch.Push
    accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
    secretKeyId: "{{ secret('AWS_SECRET_KEY_ID') }}"
    region: "us-east-1"
    namespace: "Custom/MyApp"
    metrics:
      - metricName: "RequestsCount"
        value: 42.0
        unit: "Count"
        dimensions:
          env: "prod"
          service: "payments"
      - metricName: "LatencyMs"
        value: 123.4
        unit: "Milliseconds"
        dimensions:
          env: "prod"
          service: "payments"

Properties

metrics *array

SubType

List of metrics to push

namespace *string

CloudWatch namespace, e.g., Custom/MyApp

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.

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.

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.

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

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.

stsRoleSessionName string

AWS STS Session name.

This property is only used when an stsRoleArn is defined.

Outputs

count integer

Total number of datapoints pushed

Definitions

io.kestra.plugin.aws.cloudwatch.Push-MetricValue

metricName *string

Metric name

dimensions object

Metric dimensions

unit string

Metric unit

value numberstring

Metric value