account_log_services

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

Overview

Name	account_log_services
Type	Resource
Id	fivetran.external_logging.account_log_services

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The unique identifier for the log service within the Fivetran system. (example: log_id)
config	object	The config object for the service in question (a JSON value; its keys depend on the service). The accepted keys per type are documented in the vendor's API reference and returned by the connector metadata endpoints.
enabled	boolean	The boolean value specifying whether the log service is enabled.
service	string	The name of the log service type within the Fivetran system. We support the following log services: azure_monitor_log, cloudwatch, datadog_log, dynatrace, grafana_loki, splunkLog, new_relic_log, stackdriver (Google Cloud Logging). (example: log_service_type)
setup_tests	array	Results of the most recent setup test run.
status	object	Setup status of the log service. Present when a setup status exists for the log service.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select			Returns the account-level [logging service](https:​//fivetran.com/docs/logs/external-logs) if it exists.
create	insert			Creates an account-level [logging service](https:​//fivetran.com/docs/logs/external-logs).
update	update			Updates information for the account-level [logging service](https:​//fivetran.com/docs/logs/external-logs).
delete	delete			Deletes the account-level [logging service](https:​//fivetran.com/docs/logs/external-logs).
run_setup_tests	exec			Runs the setup tests for the account-level [logging service](https:​//fivetran.com/docs/logs/external-logs).

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

SELECT examples

get

Returns the account-level logging service if it exists.

SELECT
id,
config,
enabled,
service,
setup_tests,
status
FROM fivetran.external_logging.account_log_services
;

INSERT examples

create

Creates an account-level logging service.

INSERT INTO fivetran.external_logging.account_log_services (
service,
enabled,
config,
run_setup_tests
)
SELECT 
'{{ service }}',
{{ enabled }},
'{{ config }}',
{{ run_setup_tests }}
RETURNING
id,
config,
enabled,
service,
setup_tests,
status
;

Manifest

# Description fields are for documentation purposes
- name: account_log_services
props:
  - name: service
    value: "{{ service }}"
    description: |
      The name of the log service type within the Fivetran system. We support the following log services: `azure_monitor_log`, `cloudwatch`, `datadog_log`, `dynatrace`, `grafana_loki`, `splunkLog`, `new_relic_log`, `stackdriver` (Google Cloud Logging).
  - name: enabled
    value: {{ enabled }}
    description: |
      The boolean value specifying whether the log service is enabled.
  - name: config
    value: "{{ config }}"
    description: |
      (opaque JSON object)
  - name: run_setup_tests
    value: {{ run_setup_tests }}
    description: |
      When `true`, Fivetran runs setup tests immediately after creating or updating the log service and returns the results in the `setup_tests` field of the response. Defaults to `false`.

UPDATE examples

update

Updates information for the account-level logging service.

UPDATE fivetran.external_logging.account_log_services
SET 
enabled = {{ enabled }},
config = '{{ config }}',
run_setup_tests = {{ run_setup_tests }}
RETURNING
id,
config,
enabled,
service,
setup_tests,
status;

DELETE examples

delete

Deletes the account-level logging service.

DELETE FROM fivetran.external_logging.account_log_services
;

Lifecycle Methods

EXEC variables use wire (API) names.

run_setup_tests

Runs the setup tests for the account-level logging service.

EXEC fivetran.external_logging.account_log_services.run_setup_tests 

;