output_opensearch_alias_streams

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

Overview

Name	output_opensearch_alias_streams
Type	Resource
Id	ovh.dbaas_logs.output_opensearch_alias_streams

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
value	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	alias_id, service_name		Returns the data streams attached to the alias.
create	insert	alias_id, service_name, stream_id		Attaches a data stream to the alias.
delete	delete	alias_id, service_name, stream_id		Detaches a data stream from the alias.

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_id	string (uuid)	Alias ID (wire: aliasId)
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"}})
service_name	string	Service name (wire: serviceName)
stream_id	string (uuid)	Stream ID (wire: streamId)

SELECT examples

list

Returns the data streams attached to the alias.

SELECT
value
FROM ovh.dbaas_logs.output_opensearch_alias_streams
WHERE alias_id = '{{ alias_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

INSERT examples

create

Attaches a data stream to the alias.

INSERT INTO ovh.dbaas_logs.output_opensearch_alias_streams (
stream_id,
alias_id,
service_name
)
SELECT 
'{{ stream_id }}' /* required */,
'{{ alias_id }}',
'{{ service_name }}'
RETURNING
alias_id,
dashboard_id,
encryption_key_id,
index_id,
input_id,
operation_id,
osd_id,
role_id,
stream_id,
subscription_id,
tenant_id,
token_id,
service_name,
created_at,
state,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: output_opensearch_alias_streams
props:
  - name: alias_id
    value: "{{ alias_id }}"
    description: Required parameter for the output_opensearch_alias_streams resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the output_opensearch_alias_streams resource.
  - name: stream_id
    value: "{{ stream_id }}"
    description: |
      Stream ID

DELETE examples

delete

Detaches a data stream from the alias.

DELETE FROM ovh.dbaas_logs.output_opensearch_alias_streams
WHERE alias_id = '{{ alias_id }}' --required
AND service_name = '{{ service_name }}' --required
AND stream_id = '{{ stream_id }}' --required
;