event_notifications

Creates, updates, deletes, gets or lists an event_notifications resource.

Overview

Name	event_notifications
Type	Resource
Id	cloudflare.r2.event_notifications

Fields

The following fields are returned by SELECT queries:

get

Read Configuration response.

Name	Datatype	Description
queueId	string	Queue ID. (example: 11111aa1-11aa-111a-a1a1-a1a111a11a11)
queueName	string	Name of the queue. (example: first-queue)
rules	array

list

Read Configuration response.

Name	Datatype	Description
bucketName	string	Name of the bucket.
queues	array	List of queues associated with the bucket.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	queue_id, bucket_name, account_id	cf-r2-jurisdiction	Get a single event notification rule.
list	select	bucket_name, account_id	cf-r2-jurisdiction	List all event notification rules for a bucket.
update	replace	queue_id, bucket_name, account_id, rules	cf-r2-jurisdiction	Create event notification rule.
delete	delete	queue_id, bucket_name, account_id	cf-r2-jurisdiction	Delete an event notification rule. If no body is provided, all rules for specified queue will be deleted.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
bucket_name	string	The R2 bucket name.
queue_id	string	The Cloudflare Queue ID.
cf-r2-jurisdiction	string

SELECT examples

get

Get a single event notification rule.

SELECT
queueId,
queueName,
rules
FROM cloudflare.r2.event_notifications
WHERE queue_id = '{{ queue_id }}' -- required
AND bucket_name = '{{ bucket_name }}' -- required
AND account_id = '{{ account_id }}' -- required
AND cf-r2-jurisdiction = '{{ cf-r2-jurisdiction }}'
;

list

List all event notification rules for a bucket.

SELECT
bucketName,
queues
FROM cloudflare.r2.event_notifications
WHERE bucket_name = '{{ bucket_name }}' -- required
AND account_id = '{{ account_id }}' -- required
AND cf-r2-jurisdiction = '{{ cf-r2-jurisdiction }}'
;

REPLACE examples

update

Create event notification rule.

REPLACE cloudflare.r2.event_notifications
SET 
rules = '{{ rules }}'
WHERE 
queue_id = '{{ queue_id }}' --required
AND bucket_name = '{{ bucket_name }}' --required
AND account_id = '{{ account_id }}' --required
AND rules = '{{ rules }}' --required
AND cf-r2-jurisdiction = '{{ cf-r2-jurisdiction}}'
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Delete an event notification rule. If no body is provided, all rules for specified queue will be deleted.

DELETE FROM cloudflare.r2.event_notifications
WHERE queue_id = '{{ queue_id }}' --required
AND bucket_name = '{{ bucket_name }}' --required
AND account_id = '{{ account_id }}' --required
AND cf-r2-jurisdiction = '{{ cf-r2-jurisdiction }}'
;