tenant_vault_buckets

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

Overview

Name	tenant_vault_buckets
Type	Resource
Id	ovh.backup_services.tenant_vault_buckets

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Specifies the unique identifier of the bucket
name	string	Specifies the name of the bucket
encrypted	boolean	Whether the backup data stored in the bucket is encrypted. Always true for Managed Backup buckets. Null when not reported by the platform.
immutability	object	Immutability settings of the bucket, enabled on the buckets of a PREMIUM Managed Backup vault. Null when not reported by the platform.
performance	string	Specifies the performance tier of the bucket (HIGH_PERF, STANDARD)
region	string	Specifies the geographic region where the bucket is located (af-north-lz-rba, ap-south-mum, ap-southeast-sgp, ap-southeast-syd, ca-east-bhs, ca-east-tor, eu-central-lz-buh, eu-central-lz-prg, eu-central-lz-sof, eu-central-waw, eu-north-lz-cph, eu-north-lz-hel, eu-north-lz-osl, eu-north-lz-sto, eu-south-lz-lis, eu-south-lz-mad, eu-south-lz-mil, eu-south-mil, eu-west-eri, eu-west-gra, eu-west-gra-snc, eu-west-lim, eu-west-lz-ams, eu-west-lz-bru, eu-west-lz-dln, eu-west-lz-lux, eu-west-lz-mnc, eu-west-lz-mrs, eu-west-lz-vie, eu-west-lz-zrh, eu-west-par, eu-west-rbx, eu-west-rbx-snc, eu-west-sbg, eu-west-sbg-snc, us-central-lz-slc, us-central-lz-stl, us-east-lz-atl, us-east-lz-bos, us-east-lz-chi, us-east-lz-dal, us-east-lz-mia, us-east-lz-nyc, us-east-vin, us-west-hil, us-west-lz-den, us-west-lz-lax, us-west-lz-pao, us-west-lz-phx, us-west-lz-sea)
role	string	Specifies the role assigned to the bucket (PRIMARY, REPLICA)
status	string	Specifies the current status of the bucket (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING)

list

Represents a bucket resource for a vault

Name	Datatype	Description
id	string (uuid)	Specifies the unique identifier of the bucket
name	string	Specifies the name of the bucket
encrypted	boolean	Whether the backup data stored in the bucket is encrypted. Always true for Managed Backup buckets. Null when not reported by the platform.
immutability	object	Immutability settings of the bucket, enabled on the buckets of a PREMIUM Managed Backup vault. Null when not reported by the platform.
performance	string	Specifies the performance tier of the bucket (HIGH_PERF, STANDARD)
region	string	Specifies the geographic region where the bucket is located (af-north-lz-rba, ap-south-mum, ap-southeast-sgp, ap-southeast-syd, ca-east-bhs, ca-east-tor, eu-central-lz-buh, eu-central-lz-prg, eu-central-lz-sof, eu-central-waw, eu-north-lz-cph, eu-north-lz-hel, eu-north-lz-osl, eu-north-lz-sto, eu-south-lz-lis, eu-south-lz-mad, eu-south-lz-mil, eu-south-mil, eu-west-eri, eu-west-gra, eu-west-gra-snc, eu-west-lim, eu-west-lz-ams, eu-west-lz-bru, eu-west-lz-dln, eu-west-lz-lux, eu-west-lz-mnc, eu-west-lz-mrs, eu-west-lz-vie, eu-west-lz-zrh, eu-west-par, eu-west-rbx, eu-west-rbx-snc, eu-west-sbg, eu-west-sbg-snc, us-central-lz-slc, us-central-lz-stl, us-east-lz-atl, us-east-lz-bos, us-east-lz-chi, us-east-lz-dal, us-east-lz-mia, us-east-lz-nyc, us-east-vin, us-west-hil, us-west-lz-den, us-west-lz-lax, us-west-lz-pao, us-west-lz-phx, us-west-lz-sea)
role	string	Specifies the role assigned to the bucket (PRIMARY, REPLICA)
status	string	Specifies the current status of the bucket (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	backup_services_id, bucket_id, vault_id		Gets specific vault bucket details
list	select	backup_services_id, vault_id	x_pagination_cursor, x_pagination_size	Lists buckets of the vault

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"}})
backup_services_id	string (uuid)	Backup services ID (wire: backupServicesId)
bucket_id	string (uuid)	Bucket ID (wire: bucketId)
vault_id	string	Vault ID (wire: vaultId)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Gets specific vault bucket details

SELECT
id,
name,
encrypted,
immutability,
performance,
region,
role,
status
FROM ovh.backup_services.tenant_vault_buckets
WHERE backup_services_id = '{{ backup_services_id }}' -- required
AND bucket_id = '{{ bucket_id }}' -- required
AND vault_id = '{{ vault_id }}' -- required
;

list

Lists buckets of the vault

SELECT
id,
name,
encrypted,
immutability,
performance,
region,
role,
status
FROM ovh.backup_services.tenant_vault_buckets
WHERE backup_services_id = '{{ backup_services_id }}' -- required
AND vault_id = '{{ vault_id }}' -- required
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;