voice_connector_logging_configurations

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

Overview

Name	voice_connector_logging_configurations
Type	Resource
Id	aws.chime_sdk_voice.voice_connector_logging_configurations

Fields

The following fields are returned by SELECT queries:

get_voice_connector_logging_configuration

Name	Datatype	Description
enable_media_metric_logs	boolean	Enables or disables media metrics logging.
enable_sip_logs	boolean	Boolean that enables sending SIP message logs to Amazon CloudWatch.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_voice_connector_logging_configuration	select	voice_connector_id, region		Retrieves the logging configuration settings for the specified Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
put_voice_connector_logging_configuration	replace	voice_connector_id, region, LoggingConfiguration		Updates a Voice Connector's logging configuration.

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
region	string	AWS region (default: us-east-1)
voice_connector_id	string	The Voice Connector ID.

SELECT examples

get_voice_connector_logging_configuration

Retrieves the logging configuration settings for the specified Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

SELECT
enable_media_metric_logs,
enable_sip_logs
FROM aws.chime_sdk_voice.voice_connector_logging_configurations
WHERE voice_connector_id = '{{ voice_connector_id }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_voice_connector_logging_configuration

Updates a Voice Connector's logging configuration.

REPLACE aws.chime_sdk_voice.voice_connector_logging_configurations
SET 
LoggingConfiguration = '{{ LoggingConfiguration }}'
WHERE 
voice_connector_id = '{{ voice_connector_id }}' --required
AND region = '{{ region }}' --required
AND LoggingConfiguration = '{{ LoggingConfiguration }}' --required
RETURNING
logging_configuration;