Package software.amazon.awscdk.services.workspacesweb

Class CfnUserAccessLoggingSettings

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.workspacesweb.CfnUserAccessLoggingSettings
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, IUserAccessLoggingSettingsRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:17.181Z") @Stability(Stable) public class CfnUserAccessLoggingSettings extends CfnResource implements IInspectable, IUserAccessLoggingSettingsRef, ITaggableV2
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 AWS 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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.workspacesweb.*;
 CfnUserAccessLoggingSettings cfnUserAccessLoggingSettings = CfnUserAccessLoggingSettings.Builder.create(this, "MyCfnUserAccessLoggingSettings")
         .kinesisStreamArn("kinesisStreamArn")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnUserAccessLoggingSettings

      protected CfnUserAccessLoggingSettings(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnUserAccessLoggingSettings

      protected CfnUserAccessLoggingSettings(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnUserAccessLoggingSettings

      @Stability(Stable) public CfnUserAccessLoggingSettings(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnUserAccessLoggingSettingsProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAssociatedPortalArns

      @Stability(Stable) @NotNull public List<String> getAttrAssociatedPortalArns()
      A list of web portal ARNs that this user access logging settings is associated with.

    • getAttrUserAccessLoggingSettingsArn

      @Stability(Stable) @NotNull public String getAttrUserAccessLoggingSettingsArn()
      The ARN of the user access logging settings.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getUserAccessLoggingSettingsRef

      @Stability(Stable) @NotNull public UserAccessLoggingSettingsReference getUserAccessLoggingSettingsRef()
      A reference to a UserAccessLoggingSettings resource.
      Specified by:
      getUserAccessLoggingSettingsRef in interface IUserAccessLoggingSettingsRef

    • getKinesisStreamArn

      @Stability(Stable) @NotNull public String getKinesisStreamArn()
      The ARN of the Kinesis stream.

    • setKinesisStreamArn

      @Stability(Stable) public void setKinesisStreamArn(@NotNull String value)
      The ARN of the Kinesis stream.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags to add to the user access logging settings resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags to add to the user access logging settings resource.