🚀 New! Kestra raises $3 million to grow Learn more

pluginsplugin-awstaskseventbridgeio.kestra.plugin.aws.eventbridge.putevents

​Put​Events

PutEvents PutEvents

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

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

Examples

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

yaml
id: "put_events"
type: "io.kestra.plugin.aws.eventbridge.PutEvents"
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: "put_events"
type: "io.kestra.plugin.aws.eventbridge.PutEvents"
entries:
  - eventBusName: "events"
    source: "Kestra"
    detailType: "my_object"
    detail: "{\"message\": \"hello from EventBridge and Kestra\"}"
    resources:
      - "arn:aws:iam::123456789012:user/johndoe"

Properties

entries

  • Type: object
  • Dynamic: ✔️
  • Required: ✔️

List of event entries to send to or internal storage uri to retrieve it.

A list of at least one EventBridge entry.

failOnUnsuccessfulEvents

  • Type: boolean
  • Dynamic: ❌
  • Required: ✔️
  • Default: true

Mark the task as failed when sending an event is unsuccessful.

If true, the task will fail when any event fails to be sent.

accessKeyId

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The Access Key Id in order to connect to AWS

If no connection is defined, we will use default DefaultCredentialsProvider that will try to guess the value

compatibilityMode

  • Type: boolean
  • Dynamic: ❓
  • Required: ❌

endpointOverride

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The endpoint with which the SDK should communicate.

Should normally not be used except for local development.

region

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The region with which the SDK should communicate.

secretKeyId

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The Secret Key Id in order to connect to AWS

If no connection is defined, we will use default DefaultCredentialsProvider that will try to guess the value

sessionToken

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The he AWS session token, retrieved from an AWS token service, used for authenticating that this user has received temporary permission to access some resource.

If no connection is defined, we will use default DefaultCredentialsProvider that will try to guess the value

Outputs

entryCount

  • Type: integer
  • Default: 0

The total number entries.

failedEntryCount

  • Type: integer
  • Default: 0

The number of failed entries.

uri

  • Type: string

The uri of 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.

Definitions

Entry

detailType

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

Free-form string used to decide what fields to expect in the event detail.

eventBusName

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

The name or ARN of the event bus to receive the event.

source

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

The source of the event.

detail

  • Type: object
  • Dynamic: ✔️
  • Required: ❌

The EventBridge entry.

Can be a JSON string, or a map.

resources

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

AWS resources which the event primarily concerns.

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.