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

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
session_logger_arn	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	session_loggers	INSERT	EventFilter, LogConfiguration, region
delete_resource	session_loggers	DELETE	Identifier, region
update_resource	session_loggers	UPDATE	Identifier, PatchDocument, region
list_resources	session_loggers_list_only	SELECT	region
get_resource	session_loggers	SELECT	Identifier, region

SELECT examples

get (all properties)

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
  Identifier = '{{ session_logger_arn }}';

list (identifiers only)

Lists all session_loggers in a region.

SELECT
  region,
  session_logger_arn
FROM awscc.workspacesweb.session_loggers_list_only
WHERE
  region = 'us-east-1';

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
  '{{ event_filter }}',
  '{{ log_configuration }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.workspacesweb.session_loggers (
  AdditionalEncryptionContext,
  CustomerManagedKey,
  DisplayName,
  EventFilter,
  LogConfiguration,
  Tags,
  region
)
SELECT
  '{{ additional_encryption_context }}',
  '{{ customer_managed_key }}',
  '{{ display_name }}',
  '{{ event_filter }}',
  '{{ log_configuration }}',
  '{{ 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: additional_encryption_context
        value: {}
      - name: customer_managed_key
        value: '{{ customer_managed_key }}'
      - name: display_name
        value: '{{ display_name }}'
      - name: event_filter
        value: null
      - name: log_configuration
        value:
          s3:
            bucket: '{{ bucket }}'
            key_prefix: '{{ key_prefix }}'
            bucket_owner: '{{ bucket_owner }}'
            log_file_format: '{{ log_file_format }}'
            folder_structure: '{{ folder_structure }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.workspacesweb.session_loggers
SET PatchDocument = string('{{ {
    "DisplayName": display_name,
    "EventFilter": event_filter,
    "LogConfiguration": log_configuration,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ session_logger_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.workspacesweb.session_loggers
WHERE
  Identifier = '{{ session_logger_arn }}' 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