user_s3_credentials

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

Overview

Name	user_s3_credentials
Type	Resource
Id	ovh.cloud.user_s3_credentials

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
tenant_id	string	Tenant id (wire: tenantId)
user_id	string	User id (wire: userId)
access	string	S3™ compatible access key

list

S3™ compatible storage credentials

Name	Datatype	Description
tenant_id	string	Tenant id (wire: tenantId)
user_id	string	User id (wire: userId)
access	string	S3™ compatible access key

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	access, user_id, service_name		<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. (Beta version)
list	select	user_id, service_name		<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. (Beta version)
create	insert	user_id, service_name		<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. (Beta version)
delete	delete	access, user_id, service_name		<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. (Beta version)
secret	exec	access, userId, service_name		<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. (Beta 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
access	string	Access
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"}})
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
userId	integer	User ID
user_id	integer	User ID (wire: userId)

SELECT examples

get

^* 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. (Beta version)

SELECT
tenant_id,
user_id,
access
FROM ovh.cloud.user_s3_credentials
WHERE access = '{{ access }}' -- required
AND user_id = '{{ user_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

^* 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. (Beta version)

SELECT
tenant_id,
user_id,
access
FROM ovh.cloud.user_s3_credentials
WHERE user_id = '{{ user_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

INSERT examples

create

^* 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. (Beta version)

INSERT INTO ovh.cloud.user_s3_credentials (
user_id,
service_name
)
SELECT 
'{{ user_id }}',
'{{ service_name }}'
RETURNING
tenant_id,
user_id,
access,
secret
;

Manifest

# Description fields are for documentation purposes
- name: user_s3_credentials
props:
  - name: user_id
    value: {{ user_id }}
    description: Required parameter for the user_s3_credentials resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the user_s3_credentials resource.

DELETE examples

delete

^* 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. (Beta version)

DELETE FROM ovh.cloud.user_s3_credentials
WHERE access = '{{ access }}' --required
AND user_id = '{{ user_id }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;

Lifecycle Methods

EXEC variables use wire (API) names.

secret

^* 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. (Beta version)

EXEC ovh.cloud.user_s3_credentials.secret 
@access='{{ access }}' --required, 
@userId='{{ userId }}' --required, 
@service_name='{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;