voice_connector_terminations

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

Overview

Name	voice_connector_terminations
Type	Resource
Id	aws.chime_sdk_voice.voice_connector_terminations

Fields

The following fields are returned by SELECT queries:

get_voice_connector_termination

Name	Datatype	Description
calling_regions	array	The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.
cidr_allowed_list	array	The IP addresses allowed to make calls, in CIDR format.
cps_limit	integer	The limit on calls per second. Max value based on account service quota. Default value of 1.
default_phone_number	string	The default outbound calling number. (pattern: <code>^+?[1-9]\d{1,14}$</code>)
disabled	boolean	When termination is disabled, outbound calls cannot be made.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_voice_connector_termination	select	voice_connector_id, region		Retrieves the termination setting details for the specified Voice Connector.
put_voice_connector_termination	replace	voice_connector_id, region		Updates a Voice Connector's termination settings.
delete_voice_connector_termination	delete	voice_connector_id, region		Deletes the termination settings for the specified Amazon Chime SDK Voice Connector. If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the termination settings.

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_termination

Retrieves the termination setting details for the specified Voice Connector.

SELECT
calling_regions,
cidr_allowed_list,
cps_limit,
default_phone_number,
disabled
FROM aws.chime_sdk_voice.voice_connector_terminations
WHERE voice_connector_id = '{{ voice_connector_id }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_voice_connector_termination

Updates a Voice Connector's termination settings.

REPLACE aws.chime_sdk_voice.voice_connector_terminations
SET 
Termination = '{{ Termination }}'
WHERE 
voice_connector_id = '{{ voice_connector_id }}' --required
AND region = '{{ region }}' --required
RETURNING
termination;

DELETE examples

delete_voice_connector_termination

Deletes the termination settings for the specified Amazon Chime SDK Voice Connector. If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the termination settings.

DELETE FROM aws.chime_sdk_voice.voice_connector_terminations
WHERE voice_connector_id = '{{ voice_connector_id }}' --required
AND region = '{{ region }}' --required
;