session_loggers

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

Overview

Name	session_loggers
Type	Resource
Id	aws.workspaces_web.session_loggers

Fields

The following fields are returned by SELECT queries:

get_session_logger

Name	Datatype	Description
additional_encryption_context	object	The additional encryption context of the session logger.
associated_portal_arns	array	The associated portal ARN.
creation_date	string (date-time)	The date the session logger resource was created.
customer_managed_key	string	The custom managed key of the session logger. (pattern: <code>arn:[\w+=/,.@-]+:kms:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:key/[a-zA-Z0-9-]+</code>)
display_name	string	The human-readable display name. (pattern: <code>[ _-\d\w]+</code>)
event_filter	object	The filter that specifies the events to monitor.
log_configuration	object	The configuration of the log.
session_logger_arn	string	The ARN of the session logger resource. (pattern: <code>arn:[\w+=/,.@-]+:[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(/[a-fA-F0-9-]{36})+</code>)

list_session_loggers

Name	Datatype	Description
creation_date	string (date-time)	The date the session logger resource was created.
display_name	string	The human-readable display name. (pattern: <code>[ _-\d\w]+</code>)
log_configuration	object	The configuration of the log.
session_logger_arn	string	The ARN of the session logger resource. (pattern: <code>arn:[\w+=/,.@-]+:[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(/[a-fA-F0-9-]{36})+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_session_logger	select	session_logger_arn, region		Gets details about a specific session logger resource.
list_session_loggers	select	region	nextToken, maxResults	Lists all available session logger resources.
create_session_logger	insert	region, eventFilter, logConfiguration		Creates a session logger.
associate_session_logger	update	portal_arn, sessionLoggerArn, region		Associates a session logger with a portal.
disassociate_session_logger	update	portal_arn, region		Disassociates a session logger from a portal.
update_session_logger	update	session_logger_arn, region		Updates the details of a session logger.
delete_session_logger	delete	session_logger_arn, region		Deletes a session logger resource.

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
portal_arn	string	The ARN of the portal to disassociate from the a session logger.
region	string	AWS region (default: us-east-1)
sessionLoggerArn	string	The ARN of the session logger to associate to the portal ARN.
session_logger_arn	string	The ARN of the session logger.
maxResults	integer	The maximum number of results to be included in the next page.
nextToken	string	The pagination token used to retrieve the next page of results for this operation.

SELECT examples

get_session_logger

Gets details about a specific session logger resource.

SELECT
additional_encryption_context,
associated_portal_arns,
creation_date,
customer_managed_key,
display_name,
event_filter,
log_configuration,
session_logger_arn
FROM aws.workspaces_web.session_loggers
WHERE session_logger_arn = '{{ session_logger_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_session_loggers

Lists all available session logger resources.

SELECT
creation_date,
display_name,
log_configuration,
session_logger_arn
FROM aws.workspaces_web.session_loggers
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_session_logger

Creates a session logger.

INSERT INTO aws.workspaces_web.session_loggers (
eventFilter,
logConfiguration,
displayName,
customerManagedKey,
additionalEncryptionContext,
tags,
clientToken,
region
)
SELECT 
'{{ eventFilter }}' /* required */,
'{{ logConfiguration }}' /* required */,
'{{ displayName }}',
'{{ customerManagedKey }}',
'{{ additionalEncryptionContext }}',
'{{ tags }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
session_logger_arn
;

Manifest

# Description fields are for documentation purposes
- name: session_loggers
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the session_loggers resource.
  - name: eventFilter
    description: |
      The filter that specifies the events to monitor.
    value:
      all: "{{ all }}"
      include:
        - "{{ include }}"
  - name: logConfiguration
    description: |
      The configuration of the log.
    value:
      s3:
        bucket: "{{ bucket }}"
        keyPrefix: "{{ keyPrefix }}"
        bucketOwner: "{{ bucketOwner }}"
        logFileFormat: "{{ logFileFormat }}"
        folderStructure: "{{ folderStructure }}"
  - name: displayName
    value: "{{ displayName }}"
  - name: customerManagedKey
    value: "{{ customerManagedKey }}"
  - name: additionalEncryptionContext
    value: "{{ additionalEncryptionContext }}"
  - name: tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

associate_session_logger

Associates a session logger with a portal.

UPDATE aws.workspaces_web.session_loggers
SET 
-- No updatable properties
WHERE 
portal_arn = '{{ portal_arn }}' --required
AND sessionLoggerArn = '{{ sessionLoggerArn }}' --required
AND region = '{{ region }}' --required
RETURNING
portal_arn,
session_logger_arn;

disassociate_session_logger

Disassociates a session logger from a portal.

UPDATE aws.workspaces_web.session_loggers
SET 
-- No updatable properties
WHERE 
portal_arn = '{{ portal_arn }}' --required
AND region = '{{ region }}' --required;

update_session_logger

Updates the details of a session logger.

UPDATE aws.workspaces_web.session_loggers
SET 
eventFilter = '{{ eventFilter }}',
logConfiguration = '{{ logConfiguration }}',
displayName = '{{ displayName }}'
WHERE 
session_logger_arn = '{{ session_logger_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
session_logger;

DELETE examples

delete_session_logger

Deletes a session logger resource.

DELETE FROM aws.workspaces_web.session_loggers
WHERE session_logger_arn = '{{ session_logger_arn }}' --required
AND region = '{{ region }}' --required
;