object_bucket_replication_destinations

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

Overview

Name	object_bucket_replication_destinations
Type	Resource
Id	ovh.public_cloud_storage.object_bucket_replication_destinations

Fields

The following fields are returned by SELECT queries:

list

A bucket of the project evaluated as a possible replication destination for a given source bucket

Name	Datatype	Description
name	string	Bucket name
eligible	boolean	Whether this bucket can be used as the destination of a replication rule on the source bucket
reason	string	Why the bucket cannot be used as a destination. Set only when eligible is false. (OBJECT_LOCK_INCOMPATIBLE, REGION_NOT_REPLICATION_TARGET, VERSIONING_DISABLED)
region	string	Region the bucket is located in

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	bucket_name, project_id	x_pagination_cursor, x_pagination_size	Returns the other buckets of the project and whether each one can receive objects replicated from this bucket. A bucket that cannot gives a reason: versioning disabled, incompatible object lock, or a region that does not accept replicated objects. (Alpha version)

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
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
bucket_name	string	Bucket name (wire: bucketName)
project_id	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

list

Returns the other buckets of the project and whether each one can receive objects replicated from this bucket. A bucket that cannot gives a reason: versioning disabled, incompatible object lock, or a region that does not accept replicated objects. (Alpha version)

SELECT
name,
eligible,
reason,
region
FROM ovh.public_cloud_storage.object_bucket_replication_destinations
WHERE bucket_name = '{{ bucket_name }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;