AWS::WorkSpacesWeb::UserAccessLoggingSettings - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


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

In order to receive logs from WorkSpaces Secure Browser, you must have an Amazon Kinesis Data Stream that starts with "amazon-workspaces-web-*". Your Amazon Kinesis data stream must either have server-side encryption turned off, or must use Amazon managed keys for server-side encryption.

For more information about setting server-side encryption in Amazon Kinesis, see How Do I Get Started with Server-Side Encryption?.

For more information about setting up user access logging, see Set up user access logging.


To declare this entity in your Amazon CloudFormation template, use the following syntax:


{ "Type" : "AWS::WorkSpacesWeb::UserAccessLoggingSettings", "Properties" : { "KinesisStreamArn" : String, "Tags" : [ Tag, ... ] } }


Type: AWS::WorkSpacesWeb::UserAccessLoggingSettings Properties: KinesisStreamArn: String Tags: - Tag



The ARN of the Kinesis stream.

Required: Yes

Type: String

Pattern: arn:[\w+=/,.@-]+:kinesis:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:stream/.+

Minimum: 20

Maximum: 2048

Update requires: No interruption


The tags to add to the user access logging settings resource. A tag is a key-value pair.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

Return values


When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource's Amazon Resource Name (ARN).

For more information about using the Ref function, see Ref.



A list of web portal ARNs that this user access logging settings is associated with.


The ARN of the user access logging settings.