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	awscc.workspacesweb.user_access_logging_settings

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
user_access_logging_settings_arn	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	user_access_logging_settings	INSERT	KinesisStreamArn, region
delete_resource	user_access_logging_settings	DELETE	Identifier, region
update_resource	user_access_logging_settings	UPDATE	Identifier, PatchDocument, region
list_resources	user_access_logging_settings_list_only	SELECT	region
get_resource	user_access_logging_settings	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.workspacesweb.user_access_logging_settings
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ user_access_logging_settings_arn }}';

list (identifiers only)

Lists all user_access_logging_settings in a region.

SELECT
  region,
  user_access_logging_settings_arn
FROM awscc.workspacesweb.user_access_logging_settings_list_only
WHERE
  region = 'us-east-1';

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 awscc.workspacesweb.user_access_logging_settings (
  KinesisStreamArn,
  region
)
SELECT
  '{{ kinesis_stream_arn }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.workspacesweb.user_access_logging_settings (
  KinesisStreamArn,
  Tags,
  region
)
SELECT
  '{{ kinesis_stream_arn }}',
  '{{ 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: kinesis_stream_arn
        value: '{{ kinesis_stream_arn }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.workspacesweb.user_access_logging_settings
SET PatchDocument = string('{{ {
    "KinesisStreamArn": kinesis_stream_arn,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ user_access_logging_settings_arn }}';

DELETE example

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