AWS PutEvents

AWS PutEvents
Certified
Send events to Amazon EventBridge

Publishes one or more events to EventBridge. Supports inline entries or a kestra:// URI containing serialized Entry objects. Records per-event success/failure metrics; optionally fails when any entry is rejected (failOnUnsuccessfulEvents default true).

yaml
type: io.kestra.plugin.aws.eventbridge.PutEvents

Examples

Send multiple custom events as maps to Amazon EventBridge so that they can be matched to rules

yaml
id: aws_event_bridge_put_events
namespace: company.team

tasks:
  - id: put_events
    type: io.kestra.plugin.aws.eventbridge.PutEvents
    accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
    secretKeyId: "{{ secret('AWS_SECRET_KEY_ID') }}"
    region: "eu-central-1"
    entries:
      - eventBusName: "events"
        source: "Kestra"
        detailType: "my_object"
        detail:
          message: "hello from EventBridge and Kestra"

Send multiple custom events as a JSON string to Amazon EventBridge so that they can be matched to rules

yaml
id: aws_event_bridge_put_events
namespace: company.team

tasks:
  - id: put_events
    type: io.kestra.plugin.aws.eventbridge.PutEvents
    accessKeyId: "{{ secret('AWS_ACCESS_KEY_ID') }}"
    secretKeyId: "{{ secret('AWS_SECRET_KEY_ID') }}"
    region: "eu-central-1"
    entries:
      - eventBusName: "events"
        source: "Kestra"
        detailType: "my_object"
        detail: '{"message": "hello from EventBridge and Kestra"}'
        resources:
          - "arn:aws:iam::123456789012:user/johndoe"

Properties

entries *stringarray

Event entries

List of EventBridge entries or a kestra:// URI pointing to serialized entries (ION).

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.

failOnUnsuccessfulEvents booleanstring

Defaulttrue

Fail on unsuccessful events

If true (default), task fails when EventBridge rejects at least one entry.

forcePathStyle booleanstring

Force path style access

Must only be used when compatibilityMode is enabled.

pluginDefaultsRef string

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.

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

DefaultPT15M

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

entryCount integer

Default0

The total number of entries

failedEntryCount integer

Default0

The number of failed entries

uri string

Formaturi

The URI of the stored data

The successfully and unsuccessfully ingested events. If the ingestion was successful, the entry has the event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry.

Metrics

eventbridge.put.events.duration timer

Unitnanoseconds

Duration of the PutEvents operation.

eventbridge.put.events.failed counter

Unitevents

Number of events that failed to be published to the EventBridge event bus.

eventbridge.put.events.successful counter

Unitevents

Number of events successfully published to the EventBridge event bus.

eventbridge.put.events.total counter

Unitevents