PluginsAWSTasksEventbridge

PutEvents​Put​Events

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: aws_event_bridge_put_events
namespace: company.team

tasks:
  - 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: aws_event_bridge_put_events
namespace: company.team

tasks:
  - 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:
    • string
    • array
  • 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.

compatibilityMode

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

endpointOverride

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

The endpoint with which the SDK should communicate.

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

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.

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.

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. If no credentials are defined, we will use the default credentials provider chain to fetch credentials.

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
  • 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
  • Required: ❌
  • Default: 0

failedEntryCount

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

uri

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

Definitions

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

  • detailType
    • Type: string
    • Dynamic: ✔️
    • Required: ✔️
  • eventBusName
    • Type: string
    • Dynamic: ✔️
    • Required: ✔️
  • source
    • Type: string
    • Dynamic: ✔️
    • Required: ✔️
  • detail
    • Type: object
    • Dynamic: ✔️
    • Required: ❌
  • resources
    • Type: array
    • SubType: string
    • Dynamic: ✔️
    • Required: ❌