destinations

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

Overview

Name	destinations
Type	Resource
Id	digitalocean.monitoring.destinations

Fields

The following fields are returned by SELECT queries:

monitoring_get_destination

The response is a JSON object with a destination key.

Name	Datatype	Description
id	string	A unique identifier for a destination. (example: 01f30bfa-319a-4769-ba95-9d43971fb514)
name	string	destination name (example: managed_opensearch_cluster)
config	object	OpenSearch destination configuration with credentials omitted.
type	string	The destination type. opensearch_dbaas for a DigitalOcean managed OpenSearch cluster or opensearch_ext for an externally managed one. (opensearch_dbaas, opensearch_ext) (example: opensearch_dbaas)

monitoring_list_destinations

The response is a JSON object with a destinations key.

Name	Datatype	Description
id	string	A unique identifier for a destination. (example: 01f30bfa-319a-4769-ba95-9d43971fb514)
name	string	destination name (example: managed_opensearch_cluster)
config	object	OpenSearch destination configuration with credentials omitted.
type	string	The destination type. opensearch_dbaas for a DigitalOcean managed OpenSearch cluster or opensearch_ext for an externally managed one. (opensearch_dbaas, opensearch_ext) (example: opensearch_dbaas)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
monitoring_get_destination	select	destination_uuid		To get the details of a destination, send a GET request to /v2/monitoring/sinks/destinations/${destination_uuid}.
monitoring_list_destinations	select			To list all logging destinations, send a GET request to /v2/monitoring/sinks/destinations.
monitoring_update_destination	insert	destination_uuid, config, type		To update the details of a destination, send a PATCH request to /v2/monitoring/sinks/destinations/${destination_uuid}.
monitoring_create_destination	insert	config, type		To create a new destination, send a POST request to /v2/monitoring/sinks/destinations.
monitoring_delete_destination	delete	destination_uuid		To delete a destination and all associated sinks, send a DELETE request to /v2/monitoring/sinks/destinations/${destination_uuid}.

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
destination_uuid	string	A unique identifier for a destination. (example: 1a64809f-1708-48ee-a742-dec8d481b8d1)

SELECT examples

monitoring_get_destination

To get the details of a destination, send a GET request to /v2/monitoring/sinks/destinations/${destination_uuid}.

SELECT
id,
name,
config,
type
FROM digitalocean.monitoring.destinations
WHERE destination_uuid = '{{ destination_uuid }}' -- required
;

monitoring_list_destinations

To list all logging destinations, send a GET request to /v2/monitoring/sinks/destinations.

SELECT
id,
name,
config,
type
FROM digitalocean.monitoring.destinations
;

INSERT examples

monitoring_update_destination

To update the details of a destination, send a PATCH request to /v2/monitoring/sinks/destinations/${destination_uuid}.

INSERT INTO digitalocean.monitoring.destinations (
name,
type,
config,
destination_uuid
)
SELECT 
'{{ name }}',
'{{ type }}' /* required */,
'{{ config }}' /* required */,
'{{ destination_uuid }}'
;

monitoring_create_destination

To create a new destination, send a POST request to /v2/monitoring/sinks/destinations.

INSERT INTO digitalocean.monitoring.destinations (
name,
type,
config
)
SELECT 
'{{ name }}',
'{{ type }}' /* required */,
'{{ config }}' /* required */
RETURNING
destination
;

Manifest

# Description fields are for documentation purposes
- name: destinations
props:
  - name: destination_uuid
    value: "{{ destination_uuid }}"
    description: Required parameter for the destinations resource.
  - name: name
    value: "{{ name }}"
    description: |
      destination name
  - name: type
    value: "{{ type }}"
    description: |
      The destination type. `opensearch_dbaas` for a DigitalOcean managed OpenSearch
      cluster or `opensearch_ext` for an externally managed one.
    valid_values: ['opensearch_dbaas', 'opensearch_ext']
  - name: config
    value:
      credentials:
        username: "{{ username }}"
        password: "{{ password }}"
      endpoint: "{{ endpoint }}"
      cluster_uuid: "{{ cluster_uuid }}"
      cluster_name: "{{ cluster_name }}"
      index_name: "{{ index_name }}"
      retention_days: {{ retention_days }}

DELETE examples

monitoring_delete_destination

To delete a destination and all associated sinks, send a DELETE request to /v2/monitoring/sinks/destinations/${destination_uuid}.

DELETE FROM digitalocean.monitoring.destinations
WHERE destination_uuid = '{{ destination_uuid }}' --required
;