PluginsAWSTasksEventbridgePutEvents

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"
accessKeyId: "<access-key>"
secretKeyId: "<secret-key>"
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: "put_events"
type: "io.kestra.plugin.aws.eventbridge.PutEvents"
accessKeyId: "<access-key>"
secretKeyId: "<secret-key>"
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

  • 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: ❌

Access Key Id in order to connect to AWS.

If no connection is defined, we will use the DefaultCredentialsProvider to fetch the value.

compatibilityMode

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

endpointOverride

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

The endpoint with which the SDK should communicate.

This property should normally not be used except for local development.

region

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

AWS region with which the SDK should communicate.

secretKeyId

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

Secret Key Id in order to connect to AWS.

If no connection is defined, we will use the DefaultCredentialsProvider to fetch the value.

sessionToken

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

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 connection is defined, we will use the DefaultCredentialsProvider to fetch the value.

stsEndpointOverride

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

The AWS STS endpoint with which the SDKClient should communicate.

stsRoleArn

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

AWS STS Role.

The Amazon Resource Name (ARN) of the role to assume. If set the task will use the StsAssumeRoleCredentialsProvider. Otherwise, the StaticCredentialsProvider will be used with the provided Access Key Id and Secret Key.

stsRoleExternalId

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

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

  • Type: string
  • Dynamic: ❌
  • Required: ❌
  • Default: 900.000000000
  • 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

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

AWS STS Session name. This property is only used when an stsRoleArn is defined.

Outputs

entryCount

  • Type: integer
  • Dynamic: ❓
  • Required: ❌
  • Default: 0

The total number of entries.

failedEntryCount

  • Type: integer
  • Dynamic: ❓
  • Required: ❌
  • Default: 0

The number of failed entries.

uri

  • Type: string
  • Dynamic: ❓
  • Required: ❌
  • Format: uri

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.

Definitions

io.kestra.plugin.aws.eventbridge.model.Entry

Properties

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.