sippy

Creates, updates, deletes, gets or lists a sippy resource.

Overview

Name	sippy
Type	Resource
Id	cloudflare.r2.sippy

Fields

The following fields are returned by SELECT queries:

list

Get Sippy Configuration response.

Name	Datatype	Description
destination	object	Details about the configured destination bucket.
enabled	boolean	State of Sippy for this bucket.
source	object	Details about the configured source bucket.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	account_id, bucket_name	cf-r2-jurisdiction	Gets configuration for Sippy for an existing R2 bucket.
update	replace	account_id, bucket_name	cf-r2-jurisdiction	Sets configuration for Sippy for an existing R2 bucket.
delete	delete	bucket_name, account_id	cf-r2-jurisdiction	Disables Sippy on this bucket.

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.
cf-r2-jurisdiction	string

SELECT examples

list

Gets configuration for Sippy for an existing R2 bucket.

SELECT
destination,
enabled,
source
FROM cloudflare.r2.sippy
WHERE account_id = '{{ account_id }}' -- required
AND bucket_name = '{{ bucket_name }}' -- required
AND cf-r2-jurisdiction = '{{ cf-r2-jurisdiction }}'
;

REPLACE examples

update

Sets configuration for Sippy for an existing R2 bucket.

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

DELETE examples

delete

Disables Sippy on this bucket.

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