region_share_acls

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

Overview

Name	region_share_acls
Type	Resource
Id	ovh.cloud_storage.region_share_acls

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	ACL ID
access_level	string	ACL Access Level (ro, rw) (wire: accessLevel)
access_to	string	ACL Access Resource (wire: accessTo)
access_type	string	ACL Access Type (ip) (wire: accessType)
created_at	string (date-time)	The date and timestamp when the resource was created (wire: createdAt)
status	string	ACL Status (active, applying, denying, error, queued_to_apply, queued_to_deny)
updated_at	string (date-time)	The date and timestamp when the resource was updated for the last time (wire: updatedAt)

list

Share ACL

Name	Datatype	Description
id	string (uuid)	ACL ID
access_level	string	ACL Access Level (ro, rw) (wire: accessLevel)
access_to	string	ACL Access Resource (wire: accessTo)
access_type	string	ACL Access Type (ip) (wire: accessType)
created_at	string (date-time)	The date and timestamp when the resource was created (wire: createdAt)
status	string	ACL Status (active, applying, denying, error, queued_to_apply, queued_to_deny)
updated_at	string (date-time)	The date and timestamp when the resource was updated for the last time (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	acl_id, region_name, share_id, service_name		Get share ACL
list	select	region_name, share_id, service_name		Get share ACLs
create	insert	region_name, share_id, service_name		Create share ACL
delete	delete	acl_id, region_name, share_id, service_name		Delete share ACL

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
acl_id	string (uuid)	Acl ID (wire: aclId)
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"}})
region_name	string	Region name (wire: regionName)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
share_id	string (uuid)	Share ID (wire: shareId)

SELECT examples

get

Get share ACL

SELECT
id,
access_level,
access_to,
access_type,
created_at,
status,
updated_at
FROM ovh.cloud_storage.region_share_acls
WHERE acl_id = '{{ acl_id }}' -- required
AND region_name = '{{ region_name }}' -- required
AND share_id = '{{ share_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Get share ACLs

SELECT
id,
access_level,
access_to,
access_type,
created_at,
status,
updated_at
FROM ovh.cloud_storage.region_share_acls
WHERE region_name = '{{ region_name }}' -- required
AND share_id = '{{ share_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

INSERT examples

create

Create share ACL

INSERT INTO ovh.cloud_storage.region_share_acls (
access_level,
access_to,
region_name,
share_id,
service_name
)
SELECT 
'{{ access_level }}',
'{{ access_to }}',
'{{ region_name }}',
'{{ share_id }}',
'{{ service_name }}'
RETURNING
id,
access_level,
access_to,
access_type,
created_at,
status,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: region_share_acls
props:
  - name: region_name
    value: "{{ region_name }}"
    description: Required parameter for the region_share_acls resource.
  - name: share_id
    value: "{{ share_id }}"
    description: Required parameter for the region_share_acls resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the region_share_acls resource.
  - name: access_level
    value: "{{ access_level }}"
    description: |
      ACL Access Level
    valid_values: ['ro', 'rw']
  - name: access_to
    value: "{{ access_to }}"
    description: |
      ACL Access Resource

DELETE examples

delete

Delete share ACL

DELETE FROM ovh.cloud_storage.region_share_acls
WHERE acl_id = '{{ acl_id }}' --required
AND region_name = '{{ region_name }}' --required
AND share_id = '{{ share_id }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;