vac_resources

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

Overview

Name	vac_resources
Type	Resource
Id	ovh.network_defense.vac_resources

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Unique identifier of the resource
name	string	Name you chose for the resource
created_at	string (date-time)	Date and time the resource was created (wire: createdAt)
iam	object	IAM resource metadata
resource_status	string	Current status of the resource. For a VAC resource this is only ever READY or DELETING. (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)
updated_at	string (date-time)	Date and time the resource was last updated (wire: updatedAt)

list

A VAC resource groups your anti-DDoS protection policies. It holds no protection settings of its own, so its status only reflects whether it is being deleted.

Name	Datatype	Description
id	string (uuid)	Unique identifier of the resource
name	string	Name you chose for the resource
created_at	string (date-time)	Date and time the resource was created (wire: createdAt)
iam	object	IAM resource metadata
resource_status	string	Current status of the resource. For a VAC resource this is only ever READY or DELETING. (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)
updated_at	string (date-time)	Date and time the resource was last updated (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_name		Returns a VAC DDoS protection resource with its name, status and creation and update dates. The status is READY, or DELETING while the resource is being removed.
list	select		x_pagination_cursor, x_pagination_size, iam_tags	Returns the list of VAC DDoS protection resources within the account. Every resource groups policies, profile and sensitivity with target IP address prefixes in order to tune detection and mitigation rules.
update	update	resource_name, name		Changes the name of a VAC DDoS protection resource. No other field can be updated through this call.

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"}})
resource_name	string (uuid)	Resource name (wire: resourceName)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
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 VAC DDoS protection resource with its name, status and creation and update dates. The status is READY, or DELETING while the resource is being removed.

SELECT
id,
name,
created_at,
iam,
resource_status,
updated_at
FROM ovh.network_defense.vac_resources
WHERE resource_name = '{{ resource_name }}' -- required
;

list

Returns the list of VAC DDoS protection resources within the account. Every resource groups policies, profile and sensitivity with target IP address prefixes in order to tune detection and mitigation rules.

SELECT
id,
name,
created_at,
iam,
resource_status,
updated_at
FROM ovh.network_defense.vac_resources
WHERE x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
AND iam_tags = '{{ iam_tags }}'
;

UPDATE examples

update

Changes the name of a VAC DDoS protection resource. No other field can be updated through this call.

UPDATE ovh.network_defense.vac_resources
SET 
name = '{{ name }}'
WHERE 
resource_name = '{{ resource_name }}' --required
AND name = '{{ name }}' --required
RETURNING
id,
name,
created_at,
resource_status,
updated_at;