mongodb_roles

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

Overview

Name	mongodb_roles
Type	Resource
Id	ovh.public_cloud_database.mongodb_roles

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Unique identifier of the role
name	string	Name of the role
checksum	string	Hash of the resource used for concurrency control
created_at	string (date-time)	Date at which the resource was created (wire: createdAt)
updated_at	string (date-time)	Date of the last update to the resource (wire: updatedAt)

list

A role that can be assigned to users on a managed database service

Name	Datatype	Description
id	string (uuid)	Unique identifier of the role
name	string	Name of the role
checksum	string	Hash of the resource used for concurrency control
created_at	string (date-time)	Date at which the resource was created (wire: createdAt)
updated_at	string (date-time)	Date of the last update to the resource (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	role_id, service_id, project_id		Returns a role that can be assigned to users. (Beta version)
list	select	service_id, project_id	x_pagination_cursor, x_pagination_size	Returns the roles that can be assigned to users. (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
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"}})
project_id	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
role_id	string (uuid)	Role ID (wire: roleId)
service_id	string (uuid)	Service ID (wire: serviceId)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Returns a role that can be assigned to users. (Beta version)

SELECT
id,
name,
checksum,
created_at,
updated_at
FROM ovh.public_cloud_database.mongodb_roles
WHERE role_id = '{{ role_id }}' -- required
AND service_id = '{{ service_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Returns the roles that can be assigned to users. (Beta version)

SELECT
id,
name,
checksum,
created_at,
updated_at
FROM ovh.public_cloud_database.mongodb_roles
WHERE service_id = '{{ service_id }}' -- 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 }}'
;