monitor_settings

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

Overview

Name	monitor_settings
Type	Resource
Id	aws.deadline.monitor_settings

Fields

The following fields are returned by SELECT queries:

get_monitor_settings

Name	Datatype	Description
settings	object	The monitor settings as key-value pairs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_monitor_settings	select	monitor_id, region		Gets the settings for a Deadline Cloud monitor.
update_monitor_settings	update	monitor_id, region, settings		Updates the settings for a Deadline Cloud monitor. Keys present in the request are upserted; keys absent are left unchanged. Send an empty string value to delete a key.

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
monitor_id	string	The unique identifier of the monitor to update settings for.
region	string	AWS region (default: us-east-1)

SELECT examples

get_monitor_settings

Gets the settings for a Deadline Cloud monitor.

SELECT
settings
FROM aws.deadline.monitor_settings
WHERE monitor_id = '{{ monitor_id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_monitor_settings

Updates the settings for a Deadline Cloud monitor. Keys present in the request are upserted; keys absent are left unchanged. Send an empty string value to delete a key.

UPDATE aws.deadline.monitor_settings
SET 
settings = '{{ settings }}'
WHERE 
monitor_id = '{{ monitor_id }}' --required
AND region = '{{ region }}' --required
AND settings = '{{ settings }}' --required;