instance_groups

Creates, updates, deletes, gets or lists an instance_groups resource.

Overview

Name	instance_groups
Type	Resource
Id	ovh.cloud.instance_groups

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	Instance group id
name	string	Instance group name
instance_ids	array	Instances ids
region	string	region
type	string	Instance group type (affinity, anti-affinity)

list

InstanceGroup

Name	Datatype	Description
id	string	Instance group id
name	string	Instance group name
instance_ids	array	Instances ids
region	string	region
type	string	Instance group type (affinity, anti-affinity)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	group_id, service_name	region	Get all groups
list	select	service_name	region	Get the detail of a group
create	insert	service_name, name, region, type		Create a group
delete	delete	group_id, service_name		Delete a group

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"}})
group_id	string	Group ID (wire: groupId)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
region	string	Instance region

SELECT examples

get

Get all groups

SELECT
id,
name,
instance_ids,
region,
type
FROM ovh.cloud.instance_groups
WHERE group_id = '{{ group_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND region = '{{ region }}'
;

list

Get the detail of a group

SELECT
id,
name,
instance_ids,
region,
type
FROM ovh.cloud.instance_groups
WHERE service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND region = '{{ region }}'
;

INSERT examples

create

Create a group

INSERT INTO ovh.cloud.instance_groups (
name,
region,
type,
service_name
)
SELECT 
'{{ name }}' /* required */,
'{{ region }}' /* required */,
'{{ type }}' /* required */,
'{{ service_name }}'
RETURNING
id,
name,
instance_ids,
region,
type
;

Manifest

# Description fields are for documentation purposes
- name: instance_groups
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the instance_groups resource.
  - name: name
    value: "{{ name }}"
    description: |
      instance group name
  - name: region
    value: "{{ region }}"
    description: |
      Instance region
  - name: type
    value: "{{ type }}"
    description: |
      Instance group type
    valid_values: ['affinity', 'anti-affinity']

DELETE examples

delete

Delete a group

DELETE FROM ovh.cloud.instance_groups
WHERE group_id = '{{ group_id }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;