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

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
account_id	string	The AWS Account Id that the preference is associated with, used as the unique identifier for this resource.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	preferences	INSERT	region
delete_resource	preferences	DELETE	Identifier, region
update_resource	preferences	UPDATE	Identifier, PatchDocument, region
list_resources	preferences_list_only	SELECT	region
get_resource	preferences	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual preference.

SELECT
  region,
  account_id,
  connection_recording_preferences
FROM awscc.ssmguiconnect.preferences
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ account_id }}';

list (identifiers only)

Lists all preferences in a region.

SELECT
  region,
  account_id
FROM awscc.ssmguiconnect.preferences_list_only
WHERE
  region = '{{ region }}';

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
  '{{ connection_recording_preferences }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ssmguiconnect.preferences (
  ConnectionRecordingPreferences,
  region
)
SELECT
  '{{ connection_recording_preferences }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: preference
  props:
    - name: connection_recording_preferences
      value:
        recording_destinations:
          s3_buckets:
            - bucket_owner: '{{ bucket_owner }}'
              bucket_name: '{{ bucket_name }}'
        kms_key_arn: '{{ kms_key_arn }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ssmguiconnect.preferences
SET PatchDocument = string('{{ {
    "ConnectionRecordingPreferences": connection_recording_preferences
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ account_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ssmguiconnect.preferences
WHERE
  Identifier = '{{ account_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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