synthetics_private_locations

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

Overview

Name	synthetics_private_locations
Type	Resource
Id	datadog.monitoring.synthetics_private_locations

Fields

The following fields are returned by SELECT queries:

get_private_location

Name	Datatype	Description
id	string	Unique identifier of the private location.
name	string	Name of the private location. (example: New private location)
description	string	Description of the private location. (example: Description of private location)
metadata	object	Object containing metadata about the private location.
secrets	object	Secrets for the private location. Only present in the response when creating the private location.
tags	array	Array of tags attached to the private location.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_private_location	select	location_id		Get a Synthetic private location.
create_private_location	insert	name, description, tags		Create a new Synthetic private location.
update_private_location	replace	location_id, name, description, tags		Edit a Synthetic private location.
delete_private_location	delete	location_id		Delete a Synthetic private location.

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
location_id	string	The ID of the private location.
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.

SELECT examples

get_private_location

Get a Synthetic private location.

SELECT
id,
name,
description,
metadata,
secrets,
tags
FROM datadog.monitoring.synthetics_private_locations
WHERE location_id = '{{ location_id }}' -- required
;

INSERT examples

create_private_location

Create a new Synthetic private location.

INSERT INTO datadog.monitoring.synthetics_private_locations (
description,
metadata,
name,
tags
)
SELECT 
'{{ description }}' /* required */,
'{{ metadata }}',
'{{ name }}' /* required */,
'{{ tags }}' /* required */
RETURNING
config,
private_location,
result_encryption
;

Manifest

# Description fields are for documentation purposes
- name: synthetics_private_locations
props:
  - name: description
    value: "{{ description }}"
    description: |
      Description of the private location.
  - name: metadata
    description: |
      Object containing metadata about the private location.
    value:
      restricted_roles:
        - "{{ restricted_roles }}"
  - name: name
    value: "{{ name }}"
    description: |
      Name of the private location.
  - name: tags
    value:
      - "{{ tags }}"
    description: |
      Array of tags attached to the private location.

REPLACE examples

update_private_location

Edit a Synthetic private location.

REPLACE datadog.monitoring.synthetics_private_locations
SET 
description = '{{ description }}',
metadata = '{{ metadata }}',
name = '{{ name }}',
tags = '{{ tags }}'
WHERE 
location_id = '{{ location_id }}' --required
AND name = '{{ name }}' --required
AND description = '{{ description }}' --required
AND tags = '{{ tags }}' --required
RETURNING
id,
name,
description,
metadata,
secrets,
tags;

DELETE examples

delete_private_location

Delete a Synthetic private location.

DELETE FROM datadog.monitoring.synthetics_private_locations
WHERE location_id = '{{ location_id }}' --required
;