user_access_logging_settings

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

Overview

Name	user_access_logging_settings
Type	Resource
Id	aws.workspaces_web.user_access_logging_settings

Fields

The following fields are returned by SELECT queries:

get_user_access_logging_settings

Name	Datatype	Description
associated_portal_arns	array	A list of web portal ARNs that this user access logging settings is associated with.
kinesis_stream_arn	string	Kinesis stream ARN to which log events are published. (pattern: <code>arn:[\w+=/,.@-]+:kinesis:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:stream/.+</code>)
user_access_logging_settings_arn	string	The ARN of the user access logging settings. (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_user_access_logging_settings

Name	Datatype	Description
next_token	string	The pagination token used to retrieve the next page of results for this operation. (pattern: <code>\S+</code>)
user_access_logging_settings	array	The user access logging settings.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_user_access_logging_settings	select	user_access_logging_settings_arn, region		Gets user access logging settings.
list_user_access_logging_settings	select	region	nextToken, maxResults	Retrieves a list of user access logging settings.
create_user_access_logging_settings	insert	region, kinesisStreamArn		Creates a user access logging settings resource that can be associated with a web portal.
associate_user_access_logging_settings	update	portal_arn, userAccessLoggingSettingsArn, region		Associates a user access logging settings resource with a web portal.
disassociate_user_access_logging_settings	update	portal_arn, region		Disassociates user access logging settings from a web portal.
update_user_access_logging_settings	update	user_access_logging_settings_arn, region		Updates the user access logging settings.
delete_user_access_logging_settings	delete	user_access_logging_settings_arn, region		Deletes user access logging settings.

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 web portal.
region	string	AWS region (default: us-east-1)
userAccessLoggingSettingsArn	string	The ARN of the user access logging settings.
user_access_logging_settings_arn	string	The ARN of the user access logging settings.
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_user_access_logging_settings

Gets user access logging settings.

SELECT
associated_portal_arns,
kinesis_stream_arn,
user_access_logging_settings_arn
FROM aws.workspaces_web.user_access_logging_settings
WHERE user_access_logging_settings_arn = '{{ user_access_logging_settings_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_user_access_logging_settings

Retrieves a list of user access logging settings.

SELECT
next_token,
user_access_logging_settings
FROM aws.workspaces_web.user_access_logging_settings
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_user_access_logging_settings

Creates a user access logging settings resource that can be associated with a web portal.

INSERT INTO aws.workspaces_web.user_access_logging_settings (
kinesisStreamArn,
tags,
clientToken,
region
)
SELECT 
'{{ kinesisStreamArn }}' /* required */,
'{{ tags }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
user_access_logging_settings_arn
;

Manifest

# Description fields are for documentation purposes
- name: user_access_logging_settings
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the user_access_logging_settings resource.
  - name: kinesisStreamArn
    value: "{{ kinesisStreamArn }}"
    description: |
      Kinesis stream ARN to which log events are published.
  - name: tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

associate_user_access_logging_settings

Associates a user access logging settings resource with a web portal.

UPDATE aws.workspaces_web.user_access_logging_settings
SET 
-- No updatable properties
WHERE 
portal_arn = '{{ portal_arn }}' --required
AND userAccessLoggingSettingsArn = '{{ userAccessLoggingSettingsArn }}' --required
AND region = '{{ region }}' --required
RETURNING
portal_arn,
user_access_logging_settings_arn;

disassociate_user_access_logging_settings

Disassociates user access logging settings from a web portal.

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

update_user_access_logging_settings

Updates the user access logging settings.

UPDATE aws.workspaces_web.user_access_logging_settings
SET 
kinesisStreamArn = '{{ kinesisStreamArn }}',
clientToken = '{{ clientToken }}'
WHERE 
user_access_logging_settings_arn = '{{ user_access_logging_settings_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
user_access_logging_settings;

DELETE examples

delete_user_access_logging_settings

Deletes user access logging settings.

DELETE FROM aws.workspaces_web.user_access_logging_settings
WHERE user_access_logging_settings_arn = '{{ user_access_logging_settings_arn }}' --required
AND region = '{{ region }}' --required
;