preferences

Creates, updates, deletes or gets a preference resource or lists preferences in a region

Overview

Name	preferences
Type	Resource
Description	Definition of AWS::SSMGuiConnect::Preferences Resource Type
Id	awscc.ssmguiconnect.preferences

Fields

Name	Datatype	Description
account_id	string	The AWS Account Id that the preference is associated with, used as the unique identifier for this resource.
▶connection_recording_preferences	object	The set of preferences used for recording RDP connections in the requesting AWS account and AWS Region. This includes details such as which S3 bucket recordings are stored in.
region	string	AWS region.

For more information, see AWS::SSMGuiConnect::Preferences.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual preference.

SELECT
region,
account_id,
connection_recording_preferences
FROM awscc.ssmguiconnect.preferences
WHERE region = 'us-east-1' AND data__Identifier = '<AccountId>';

INSERT example

Use the following StackQL query and manifest file to create a new preference resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.ssmguiconnect.preferences (
 ConnectionRecordingPreferences,
 region
)
SELECT 
'{{ ConnectionRecordingPreferences }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.ssmguiconnect.preferences (
 ConnectionRecordingPreferences,
 region
)
SELECT 
 '{{ ConnectionRecordingPreferences }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: preference
    props:
      - name: ConnectionRecordingPreferences
        value:
          RecordingDestinations:
            S3Buckets:
              - BucketOwner: '{{ BucketOwner }}'
                BucketName: '{{ BucketName }}'
          KMSKeyArn: '{{ KMSKeyArn }}'

DELETE example

/*+ delete */
DELETE FROM awscc.ssmguiconnect.preferences
WHERE data__Identifier = '<AccountId>'
AND region = 'us-east-1';

Permissions

To operate on the preferences resource, the following permissions are required:

Create

kms:CreateGrant,
ssm-guiconnect:UpdateConnectionRecordingPreferences,
ssm-guiconnect:GetConnectionRecordingPreferences

Read

ssm-guiconnect:GetConnectionRecordingPreferences

Update

kms:CreateGrant,
ssm-guiconnect:UpdateConnectionRecordingPreferences,
ssm-guiconnect:GetConnectionRecordingPreferences,
ssm-guiconnect:DeleteConnectionRecordingPreferences

Delete

ssm-guiconnect:GetConnectionRecordingPreferences,
ssm-guiconnect:DeleteConnectionRecordingPreferences

List

ssm-guiconnect:GetConnectionRecordingPreferences