# AWS::WorkSpacesWeb Construct Library

---

![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)

> All classes with the `Cfn` prefix in this module ([CFN Resources]) are always stable and safe to use.
>
> [CFN Resources]: https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib

---

This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.

```ts
import * as workspacesweb from 'aws-cdk-lib/aws-workspacesweb';
```

There are no official hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet. Here are some suggestions on how to proceed:

- Search [Construct Hub for WorkSpacesWeb construct libraries](https://constructs.dev/search?q=workspacesweb)
- Use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, in the same way you would use [the CloudFormation AWS::WorkSpacesWeb resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_WorkSpacesWeb.html) directly.

There are no hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet.
However, you can still use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the [CloudFormation documentation for AWS::WorkSpacesWeb](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_WorkSpacesWeb.html).

(Read the [CDK Contributing Guide](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and submit an RFC if you are interested in contributing to this construct library.)

## Types

| Name | Kind | Summary |
| --- | --- | --- |
| [`CfnBrowserSettings`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnBrowserSettings) | Construct (L1) | This resource specifies browser settings that can be associated with a web portal. |
| [`CfnDataProtectionSettings`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnDataProtectionSettings) | Construct (L1) | The data protection settings resource that can be associated with a web portal. |
| [`CfnIdentityProvider`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnIdentityProvider) | Construct (L1) | This resource specifies an identity provider that is then associated with a web portal. |
| [`CfnIpAccessSettings`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnIpAccessSettings) | Construct (L1) | This resource specifies IP access settings that can be associated with a web portal. |
| [`CfnNetworkSettings`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnNetworkSettings) | Construct (L1) | This resource specifies network settings that can be associated with a web portal. |
| [`CfnPortal`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnPortal) | Construct (L1) | This resource specifies a web portal, which users use to start browsing sessions. |
| [`CfnSessionLogger`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnSessionLogger) | Construct (L1) | The session logger resource. |
| [`CfnTrustStore`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnTrustStore) | Construct (L1) | This resource specifies a trust store that can be associated with a web portal. |
| [`CfnUserAccessLoggingSettings`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnUserAccessLoggingSettings) | Construct (L1) | This resource specifies user access logging settings that can be associated with a web portal. |
| [`CfnUserSettings`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnUserSettings) | Construct (L1) | This resource specifies user settings that can be associated with a web portal. |
| [`CfnBrowserSettings.WebContentFilteringPolicyProperty`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnBrowserSettings.WebContentFilteringPolicyProperty) | Struct | The policy that specifies which URLs end users are allowed to access or which URLs or domain categories they are restricted from accessing for enhanced security. |
| [`CfnBrowserSettingsProps`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnBrowserSettingsProps) | Struct | Properties for defining a `CfnBrowserSettings`. |
| [`CfnDataProtectionSettings.CustomPatternProperty`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnDataProtectionSettings.CustomPatternProperty) | Struct | The pattern configuration for redacting custom data types in session. |
| [`CfnDataProtectionSettings.InlineRedactionConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnDataProtectionSettings.InlineRedactionConfigurationProperty) | Struct | The configuration for in-session inline redaction. |
| [`CfnDataProtectionSettings.InlineRedactionPatternProperty`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnDataProtectionSettings.InlineRedactionPatternProperty) | Struct | The set of patterns that determine the data types redacted in session. |
| [`CfnDataProtectionSettings.RedactionPlaceHolderProperty`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnDataProtectionSettings.RedactionPlaceHolderProperty) | Struct | The redaction placeholder that will replace the redacted text in session. |
| [`CfnDataProtectionSettingsProps`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnDataProtectionSettingsProps) | Struct | Properties for defining a `CfnDataProtectionSettings`. |
| [`CfnIdentityProviderProps`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnIdentityProviderProps) | Struct | Properties for defining a `CfnIdentityProvider`. |
| [`CfnIpAccessSettings.IpRuleProperty`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnIpAccessSettings.IpRuleProperty) | Struct | The IP rules of the IP access settings. |
| [`CfnIpAccessSettingsProps`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnIpAccessSettingsProps) | Struct | Properties for defining a `CfnIpAccessSettings`. |
| [`CfnNetworkSettingsProps`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnNetworkSettingsProps) | Struct | Properties for defining a `CfnNetworkSettings`. |
| [`CfnPortalProps`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnPortalProps) | Struct | Properties for defining a `CfnPortal`. |
| [`CfnSessionLogger.EventFilterProperty`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnSessionLogger.EventFilterProperty) | Struct | The filter that specifies the events to monitor. |
| [`CfnSessionLogger.LogConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnSessionLogger.LogConfigurationProperty) | Struct | The configuration of the log. |
| [`CfnSessionLogger.S3LogConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnSessionLogger.S3LogConfigurationProperty) | Struct | The S3 log configuration. |
| [`CfnSessionLoggerProps`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnSessionLoggerProps) | Struct | Properties for defining a `CfnSessionLogger`. |
| [`CfnTrustStoreProps`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnTrustStoreProps) | Struct | Properties for defining a `CfnTrustStore`. |
| [`CfnUserAccessLoggingSettingsProps`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnUserAccessLoggingSettingsProps) | Struct | Properties for defining a `CfnUserAccessLoggingSettings`. |
| [`CfnUserSettings.BrandingConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnUserSettings.BrandingConfigurationProperty) | Struct | The branding configuration that customizes the appearance of the web portal for end users. |
| [`CfnUserSettings.CookieSpecificationProperty`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnUserSettings.CookieSpecificationProperty) | Struct | Specifies a single cookie or set of cookies in an end user's browser. |
| [`CfnUserSettings.CookieSynchronizationConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnUserSettings.CookieSynchronizationConfigurationProperty) | Struct | The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. |
| [`CfnUserSettings.ImageMetadataProperty`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnUserSettings.ImageMetadataProperty) | Struct | Metadata information about an uploaded image file. |
| [`CfnUserSettings.LocalizedBrandingStringsProperty`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnUserSettings.LocalizedBrandingStringsProperty) | Struct | Localized text strings for a specific language that customize the web portal. |
| [`CfnUserSettings.ToolbarConfigurationProperty`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnUserSettings.ToolbarConfigurationProperty) | Struct | The configuration of the toolbar. |
| [`CfnUserSettingsProps`](/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnUserSettingsProps) | Struct | Properties for defining a `CfnUserSettings`. |
