connection_recording_preferences

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

Overview

Name	connection_recording_preferences
Type	Resource
Id	aws.ssm_guiconnect.connection_recording_preferences

Fields

The following fields are returned by SELECT queries:

get_connection_recording_preferences

Name	Datatype	Description
client_token	string	Service-provided idempotency token.
connection_recording_preferences	object	The set of preferences used for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region. This includes details such as which S3 bucket recordings are stored in.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_connection_recording_preferences	select	region		Returns the preferences specified for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region.
update_connection_recording_preferences	update	region, ConnectionRecordingPreferences		Updates the preferences for recording RDP connections.
delete_connection_recording_preferences	delete	region		Deletes the preferences for recording RDP connections.

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)

SELECT examples

get_connection_recording_preferences

Returns the preferences specified for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region.

SELECT
client_token,
connection_recording_preferences
FROM aws.ssm_guiconnect.connection_recording_preferences
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_connection_recording_preferences

Updates the preferences for recording RDP connections.

UPDATE aws.ssm_guiconnect.connection_recording_preferences
SET 
ClientToken = '{{ ClientToken }}',
ConnectionRecordingPreferences = '{{ ConnectionRecordingPreferences }}'
WHERE 
region = '{{ region }}' --required
AND ConnectionRecordingPreferences = '{{ ConnectionRecordingPreferences }}' --required
RETURNING
client_token,
connection_recording_preferences;

DELETE examples

delete_connection_recording_preferences

Deletes the preferences for recording RDP connections.

DELETE FROM aws.ssm_guiconnect.connection_recording_preferences
WHERE region = '{{ region }}' --required
;