PutEvents
Send custom events to Amazon EventBridge for rule matching.
Send custom events to Amazon EventBridge for rule matching.
Send custom events to Amazon EventBridge for rule matching.
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.
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.
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*Requiredstringarray
List of event entries to send to, or internal storage URI to retrieve it.
A list of at least one EventBridge entry.
accessKeyIdstring
Access Key Id in order to connect to AWS.
compatibilityModebooleanstring
Enable compatibility mode.
Use it to connect to S3 bucket with S3 compatible services that don't support the new transport client.
endpointOverridestring
The endpoint with which the SDK should communicate.
This property allows you to use a different S3 compatible storage backend.
failOnUnsuccessfulEventsbooleanstring
trueMark the task as failed when sending an event is unsuccessful.
If true, the task will fail when any event fails to be sent.
forcePathStylebooleanstring
Force path style access.
Must only be used when compatibilityMode is enabled.
regionstring
AWS region with which the SDK should communicate.
secretKeyIdstring
Secret Key Id in order to connect to AWS.
sessionTokenstring
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.
stsEndpointOverridestring
The AWS STS endpoint with which the SDKClient should communicate.
stsRoleArnstring
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.
stsRoleExternalIdstring
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.
stsRoleSessionDurationstring
PT15MdurationAWS 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.
stsRoleSessionNamestring
AWS STS Session name.
This property is only used when an stsRoleArn is defined.
Outputs
entryCountinteger
0The total number of entries.
failedEntryCountinteger
0The number of failed entries.
uristring
uriThe 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.durationtimer
nanosecondsDuration of the PutEvents operation.
eventbridge.put.events.failedcounter
eventsNumber of events that failed to be published to the EventBridge event bus.
eventbridge.put.events.successfulcounter
eventsNumber of events successfully published to the EventBridge event bus.
eventbridge.put.events.totalcounter
eventsTotal number of events sent to the EventBridge event bus.
