network_settings
Creates, updates, deletes, gets or lists a network_settings resource.
Overview
| Name | network_settings |
| Type | Resource |
| Id | aws.wickr.network_settings |
Fields
The following fields are returned by SELECT queries:
- get_network_settings
| Name | Datatype | Description |
|---|---|---|
settings | array | A list of network settings, where each setting includes a name, value, and type. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_network_settings | select | network_id, region | Retrieves all network-level settings for a Wickr network, including client metrics, data retention, and other configuration options. | |
update_network_settings | update | network_id, region, settings | Updates network-level settings for a Wickr network. You can modify settings such as client metrics, data retention, and other network-wide options. |
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 |
|---|---|---|
network_id | string | The ID of the Wickr network whose settings will be updated. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_network_settings
Retrieves all network-level settings for a Wickr network, including client metrics, data retention, and other configuration options.
SELECT
settings
FROM aws.wickr.network_settings
WHERE network_id = '{{ network_id }}' -- required
AND region = '{{ region }}' -- required
;
UPDATE examples
- update_network_settings
Updates network-level settings for a Wickr network. You can modify settings such as client metrics, data retention, and other network-wide options.
UPDATE aws.wickr.network_settings
SET
settings = '{{ settings }}'
WHERE
network_id = '{{ network_id }}' --required
AND region = '{{ region }}' --required
AND settings = '{{ settings }}' --required
RETURNING
settings;