session_loggers

Creates, updates, deletes or gets a session_logger resource or lists session_loggers in a region

Overview

Name	session_loggers
Type	Resource
Description	Definition of AWS::WorkSpacesWeb::SessionLogger Resource Type
Id	awscc.workspacesweb.session_loggers

Fields

Name	Datatype	Description
additional_encryption_context	object
associated_portal_arns	array
creation_date	string
customer_managed_key	string
display_name	string
event_filter	object
▶log_configuration	object
session_logger_arn	string
▶tags	array
region	string	AWS region.

For more information, see AWS::WorkSpacesWeb::SessionLogger.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	EventFilter, LogConfiguration, 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 session_logger.

SELECT
region,
additional_encryption_context,
associated_portal_arns,
creation_date,
customer_managed_key,
display_name,
event_filter,
log_configuration,
session_logger_arn,
tags
FROM awscc.workspacesweb.session_loggers
WHERE region = 'us-east-1' AND data__Identifier = '<SessionLoggerArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.workspacesweb.session_loggers (
 EventFilter,
 LogConfiguration,
 region
)
SELECT 
'{{ EventFilter }}',
 '{{ LogConfiguration }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.workspacesweb.session_loggers (
 AdditionalEncryptionContext,
 CustomerManagedKey,
 DisplayName,
 EventFilter,
 LogConfiguration,
 Tags,
 region
)
SELECT 
 '{{ AdditionalEncryptionContext }}',
 '{{ CustomerManagedKey }}',
 '{{ DisplayName }}',
 '{{ EventFilter }}',
 '{{ LogConfiguration }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: session_logger
    props:
      - name: AdditionalEncryptionContext
        value: {}
      - name: CustomerManagedKey
        value: '{{ CustomerManagedKey }}'
      - name: DisplayName
        value: '{{ DisplayName }}'
      - name: EventFilter
        value: null
      - name: LogConfiguration
        value:
          S3:
            Bucket: '{{ Bucket }}'
            KeyPrefix: '{{ KeyPrefix }}'
            BucketOwner: '{{ BucketOwner }}'
            LogFileFormat: '{{ LogFileFormat }}'
            FolderStructure: '{{ FolderStructure }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.workspacesweb.session_loggers
WHERE data__Identifier = '<SessionLoggerArn>'
AND region = 'us-east-1';

Permissions

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

Create

workspaces-web:CreateSessionLogger,
workspaces-web:GetSessionLogger,
workspaces-web:ListSessionLoggers,
workspaces-web:ListTagsForResource,
workspaces-web:TagResource,
s3:PutObject,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt,
kms:GenerateDataKeyWithoutPlaintext,
kms:ReEncryptTo,
kms:ReEncryptFrom

Read

workspaces-web:GetSessionLogger,
workspaces-web:ListTagsForResource,
kms:Decrypt

Update

workspaces-web:UpdateSessionLogger,
workspaces-web:GetSessionLogger,
workspaces-web:ListSessionLoggers,
workspaces-web:TagResource,
workspaces-web:UntagResource,
workspaces-web:ListTagsForResource,
s3:PutObject,
kms:GenerateDataKey,
kms:Decrypt

Delete

workspaces-web:GetSessionLogger,
workspaces-web:DeleteSessionLogger,
kms:Decrypt

List

workspaces-web:ListSessionLoggers,
kms:Decrypt