Skip to main content

tenant_vault_bucket_credentials

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

Overview​

Nametenant_vault_bucket_credentials
TypeResource
Idovh.backup_services.tenant_vault_bucket_credentials

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
bucket_namestringName of the bucket these credentials belong to (wire: bucketName)
access_keystringS3 access key (wire: accessKey)
endpointstringS3 endpoint URL to configure in your environment
region_codestringShort region code of the bucket (ap-south-mum, ap-southeast-syd, bhs, ca-east-tor, de, eu-south-mil, eu-west-par, gra, rbx, sbg, sgp, uk, waw) (wire: regionCode)
secret_keystring (password)S3 secret key, sensitive value (wire: secretKey)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectbackup_services_id, bucket_id, vault_id<sup>*</sup> S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc.

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.

NameDatatypeDescription
api_hoststringThe 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_idstring (uuid)Backup services ID (wire: backupServicesId)
bucket_idstring (uuid)Bucket ID (wire: bucketId)
vault_idstringVault ID (wire: vaultId)

SELECT examples​

<sup>*</sup> S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc.

SELECT
bucket_name,
access_key,
endpoint,
region_code,
secret_key
FROM ovh.backup_services.tenant_vault_bucket_credentials
WHERE backup_services_id = '{{ backup_services_id }}' -- required
AND bucket_id = '{{ bucket_id }}' -- required
AND vault_id = '{{ vault_id }}' -- required
;