user_access_logging_settings

Creates, updates, deletes or gets an user_access_logging_setting resource or lists user_access_logging_settings in a region

Overview

Name	user_access_logging_settings
Type	Resource
Description	Definition of AWS::WorkSpacesWeb::UserAccessLoggingSettings Resource Type
Id	aws.workspacesweb.user_access_logging_settings

Fields

Name	Datatype	Description
associated_portal_arns	array
kinesis_stream_arn	string	Kinesis stream ARN to which log events are published.
tags	array
user_access_logging_settings_arn	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	KinesisStreamArn, 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 user_access_logging_settings in a region.

SELECT
region,
associated_portal_arns,
kinesis_stream_arn,
tags,
user_access_logging_settings_arn
FROM aws.workspacesweb.user_access_logging_settings
WHERE region = 'us-east-1';

Gets all properties from an individual user_access_logging_setting.

SELECT
region,
associated_portal_arns,
kinesis_stream_arn,
tags,
user_access_logging_settings_arn
FROM aws.workspacesweb.user_access_logging_settings
WHERE region = 'us-east-1' AND data__Identifier = '<UserAccessLoggingSettingsArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.workspacesweb.user_access_logging_settings (
 KinesisStreamArn,
 region
)
SELECT 
'{{ KinesisStreamArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.workspacesweb.user_access_logging_settings (
 KinesisStreamArn,
 Tags,
 region
)
SELECT 
 '{{ KinesisStreamArn }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: user_access_logging_setting
    props:
      - name: KinesisStreamArn
        value: '{{ KinesisStreamArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.workspacesweb.user_access_logging_settings
WHERE data__Identifier = '<UserAccessLoggingSettingsArn>'
AND region = 'us-east-1';

Permissions

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

Create

workspaces-web:CreateUserAccessLoggingSettings,
workspaces-web:GetUserAccessLoggingSettings,
workspaces-web:ListTagsForResource,
workspaces-web:TagResource

Read

workspaces-web:GetUserAccessLoggingSettings,
workspaces-web:ListTagsForResource

Update

workspaces-web:UpdateUserAccessLoggingSettings,
workspaces-web:TagResource,
workspaces-web:UntagResource,
workspaces-web:GetUserAccessLoggingSettings,
workspaces-web:ListTagsForResource,
kinesis:PutRecord,
kinesis:PutRecords

Delete

workspaces-web:GetUserAccessLoggingSettings,
workspaces-web:DeleteUserAccessLoggingSettings

List

workspaces-web:ListUserAccessLoggingSettings