data_region_aliases

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

Overview

Name	data_region_aliases
Type	Resource
Id	ovh.cloud_ai.data_region_aliases

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
alias	string	Data store alias
endpoint	string	Data store endpoint URL
owner	string	Owner type of the datastore (customer, ovhcloud)
type	string	Type of the datastore (git, s3, swift)

list

AI Solutions data store container Volume Object

Name	Datatype	Description
alias	string	Data store alias
endpoint	string	Data store endpoint URL
owner	string	Owner type of the datastore (customer, ovhcloud)
type	string	Type of the datastore (git, s3, swift)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	alias, region, service_name		Get Datastore Information
list	select	region, service_name		List datastores
create	insert	region, service_name, alias, credentials, endpoint, owner, type	skip_data_store_connection_check	Create a new datastore
update	update	alias, region, service_name, alias, credentials, endpoint, owner, type		Update a datastore
delete	delete	alias, region, service_name		Permanently delete a datastore

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
alias	string	Alias
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	string	Region
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
skip_data_store_connection_check	boolean	If set to true, it will skip the data store connection check (wire: skipDataStoreConnectionCheck)

SELECT examples

get

Get Datastore Information

SELECT
alias,
endpoint,
owner,
type
FROM ovh.cloud_ai.data_region_aliases
WHERE alias = '{{ alias }}' -- required
AND region = '{{ region }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List datastores

SELECT
alias,
endpoint,
owner,
type
FROM ovh.cloud_ai.data_region_aliases
WHERE region = '{{ region }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

INSERT examples

create

Create a new datastore

INSERT INTO ovh.cloud_ai.data_region_aliases (
alias,
credentials,
endpoint,
owner,
prefix,
type,
region,
service_name,
skip_data_store_connection_check
)
SELECT 
'{{ alias }}' /* required */,
'{{ credentials }}' /* required */,
'{{ endpoint }}' /* required */,
'{{ owner }}' /* required */,
'{{ prefix }}',
'{{ type }}' /* required */,
'{{ region }}',
'{{ service_name }}',
'{{ skip_data_store_connection_check }}'
RETURNING
alias,
endpoint,
owner,
type
;

Manifest

# Description fields are for documentation purposes
- name: data_region_aliases
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the data_region_aliases resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the data_region_aliases resource.
  - name: alias
    value: "{{ alias }}"
    description: |
      Data store alias
  - name: credentials
    description: |
      Data store credentials
    value:
      git:
        basicAuth:
          password: "{{ password }}"
          username: "{{ username }}"
        sshKeypair:
          privateKey: "{{ privateKey }}"
          publicKey: "{{ publicKey }}"
      s3:
        accessKey: "{{ accessKey }}"
        region: "{{ region }}"
        secretKey: "{{ secretKey }}"
  - name: endpoint
    value: "{{ endpoint }}"
    description: |
      Datastore endpoint
  - name: owner
    value: "{{ owner }}"
    description: |
      Data store owner
    valid_values: ['customer', 'ovhcloud']
  - name: prefix
    value: "{{ prefix }}"
    description: |
      Data store prefix
  - name: type
    value: "{{ type }}"
    description: |
      Data store type
    valid_values: ['git', 's3', 'swift']
  - name: skip_data_store_connection_check
    value: {{ skip_data_store_connection_check }}
    description: If set to true, it will skip the data store connection check
    description: If set to true, it will skip the data store connection check

UPDATE examples

update

Update a datastore

UPDATE ovh.cloud_ai.data_region_aliases
SET 
alias = '{{ alias }}',
credentials = '{{ credentials }}',
endpoint = '{{ endpoint }}',
owner = '{{ owner }}',
prefix = '{{ prefix }}',
type = '{{ type }}'
WHERE 
alias = '{{ alias }}' --required
AND region = '{{ region }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
AND alias = '{{ alias }}' --required
AND credentials = '{{ credentials }}' --required
AND endpoint = '{{ endpoint }}' --required
AND owner = '{{ owner }}' --required
AND type = '{{ type }}' --required;

DELETE examples

delete

Permanently delete a datastore

DELETE FROM ovh.cloud_ai.data_region_aliases
WHERE alias = '{{ alias }}' --required
AND region = '{{ region }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;