aws-cdk-lib 2.172.0__py3-none-any.whl → 2.173.1__py3-none-any.whl

aws_cdk/aws_workspacesweb/__init__.py

@@ -383,7 +383,7 @@ class CfnDataProtectionSettings(
     metaclass=jsii.JSIIMeta,
     jsii_type="aws-cdk-lib.aws_workspacesweb.CfnDataProtectionSettings",
 ):
-    '''Definition of AWS::WorkSpacesWeb::DataProtectionSettings Resource Type.
+    '''The data protection settings resource that can be associated with a web portal.
 
     :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-dataprotectionsettings.html
     :cloudformationResource: AWS::WorkSpacesWeb::DataProtectionSettings
@@ -453,12 +453,12 @@ class CfnDataProtectionSettings(
         '''
         :param scope: Scope in which this resource is defined.
         :param id: Construct identifier for this resource (unique in its scope).
-        :param additional_encryption_context: 
-        :param customer_managed_key: 
-        :param description: 
-        :param display_name: 
-        :param inline_redaction_configuration: 
-        :param tags: 
+        :param additional_encryption_context: The additional encryption context of the data protection settings.
+        :param customer_managed_key: The customer managed key used to encrypt sensitive information in the data protection settings.
+        :param description: The description of the data protection settings.
+        :param display_name: The display name of the data protection settings.
+        :param inline_redaction_configuration: The inline redaction configuration for the data protection settings.
+        :param tags: The tags of the data protection settings.
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__851565cba0af7c67b6951a864a7d6671af0039654a56671ed86d28919552d73e)
@@ -508,7 +508,8 @@ class CfnDataProtectionSettings(
     @builtins.property
     @jsii.member(jsii_name="attrAssociatedPortalArns")
     def attr_associated_portal_arns(self) -> typing.List[builtins.str]:
-        '''
+        '''A list of web portal ARNs that this data protection settings resource is associated with.
+
         :cloudformationAttribute: AssociatedPortalArns
         '''
         return typing.cast(typing.List[builtins.str], jsii.get(self, "attrAssociatedPortalArns"))
@@ -516,7 +517,8 @@ class CfnDataProtectionSettings(
     @builtins.property
     @jsii.member(jsii_name="attrCreationDate")
     def attr_creation_date(self) -> builtins.str:
-        '''
+        '''The creation date timestamp of the data protection settings.
+
         :cloudformationAttribute: CreationDate
         '''
         return typing.cast(builtins.str, jsii.get(self, "attrCreationDate"))
@@ -524,7 +526,8 @@ class CfnDataProtectionSettings(
     @builtins.property
     @jsii.member(jsii_name="attrDataProtectionSettingsArn")
     def attr_data_protection_settings_arn(self) -> builtins.str:
-        '''
+        '''The ARN of the data protection settings resource.
+
         :cloudformationAttribute: DataProtectionSettingsArn
         '''
         return typing.cast(builtins.str, jsii.get(self, "attrDataProtectionSettingsArn"))
@@ -545,6 +548,7 @@ class CfnDataProtectionSettings(
     def additional_encryption_context(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]]:
+        '''The additional encryption context of the data protection settings.'''
         return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]], jsii.get(self, "additionalEncryptionContext"))
 
     @additional_encryption_context.setter
@@ -560,6 +564,7 @@ class CfnDataProtectionSettings(
     @builtins.property
     @jsii.member(jsii_name="customerManagedKey")
     def customer_managed_key(self) -> typing.Optional[builtins.str]:
+        '''The customer managed key used to encrypt sensitive information in the data protection settings.'''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "customerManagedKey"))
 
     @customer_managed_key.setter
@@ -572,6 +577,7 @@ class CfnDataProtectionSettings(
     @builtins.property
     @jsii.member(jsii_name="description")
     def description(self) -> typing.Optional[builtins.str]:
+        '''The description of the data protection settings.'''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "description"))
 
     @description.setter
@@ -584,6 +590,7 @@ class CfnDataProtectionSettings(
     @builtins.property
     @jsii.member(jsii_name="displayName")
     def display_name(self) -> typing.Optional[builtins.str]:
+        '''The display name of the data protection settings.'''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "displayName"))
 
     @display_name.setter
@@ -598,6 +605,7 @@ class CfnDataProtectionSettings(
     def inline_redaction_configuration(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataProtectionSettings.InlineRedactionConfigurationProperty"]]:
+        '''The inline redaction configuration for the data protection settings.'''
         return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataProtectionSettings.InlineRedactionConfigurationProperty"]], jsii.get(self, "inlineRedactionConfiguration"))
 
     @inline_redaction_configuration.setter
@@ -613,6 +621,7 @@ class CfnDataProtectionSettings(
     @builtins.property
     @jsii.member(jsii_name="tags")
     def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
+        '''The tags of the data protection settings.'''
         return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
 
     @tags.setter
@@ -641,11 +650,12 @@ class CfnDataProtectionSettings(
             keyword_regex: typing.Optional[builtins.str] = None,
             pattern_description: typing.Optional[builtins.str] = None,
         ) -> None:
-            '''
-            :param pattern_name: 
-            :param pattern_regex: 
-            :param keyword_regex: 
-            :param pattern_description: 
+            '''The pattern configuration for redacting custom data types in session.
+
+            :param pattern_name: The pattern name for the custom pattern.
+            :param pattern_regex: The pattern regex for the customer pattern. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example: “/ab+c/gi”.
+            :param keyword_regex: The keyword regex for the customer pattern. After there is a match to the pattern regex, the keyword regex is used to search within the proximity of the match. If there is a keyword match, then the match is confirmed. If no keyword regex is provided, the pattern regex match will automatically be confirmed. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example, “/ab+c/gi”
+            :param pattern_description: The pattern description for the customer pattern.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-custompattern.html
             :exampleMetadata: fixture=_generated
@@ -682,7 +692,8 @@ class CfnDataProtectionSettings(
 
         @builtins.property
         def pattern_name(self) -> builtins.str:
-            '''
+            '''The pattern name for the custom pattern.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-custompattern.html#cfn-workspacesweb-dataprotectionsettings-custompattern-patternname
             '''
             result = self._values.get("pattern_name")
@@ -691,7 +702,10 @@ class CfnDataProtectionSettings(
 
         @builtins.property
         def pattern_regex(self) -> builtins.str:
-            '''
+            '''The pattern regex for the customer pattern.
+
+            The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example: “/ab+c/gi”.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-custompattern.html#cfn-workspacesweb-dataprotectionsettings-custompattern-patternregex
             '''
             result = self._values.get("pattern_regex")
@@ -700,7 +714,10 @@ class CfnDataProtectionSettings(
 
         @builtins.property
         def keyword_regex(self) -> typing.Optional[builtins.str]:
-            '''
+            '''The keyword regex for the customer pattern.
+
+            After there is a match to the pattern regex, the keyword regex is used to search within the proximity of the match. If there is a keyword match, then the match is confirmed. If no keyword regex is provided, the pattern regex match will automatically be confirmed. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example, “/ab+c/gi”
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-custompattern.html#cfn-workspacesweb-dataprotectionsettings-custompattern-keywordregex
             '''
             result = self._values.get("keyword_regex")
@@ -708,7 +725,8 @@ class CfnDataProtectionSettings(
 
         @builtins.property
         def pattern_description(self) -> typing.Optional[builtins.str]:
-            '''
+            '''The pattern description for the customer pattern.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-custompattern.html#cfn-workspacesweb-dataprotectionsettings-custompattern-patterndescription
             '''
             result = self._values.get("pattern_description")
@@ -744,11 +762,12 @@ class CfnDataProtectionSettings(
             global_enforced_urls: typing.Optional[typing.Sequence[builtins.str]] = None,
             global_exempt_urls: typing.Optional[typing.Sequence[builtins.str]] = None,
         ) -> None:
-            '''
-            :param inline_redaction_patterns: 
-            :param global_confidence_level: 
-            :param global_enforced_urls: 
-            :param global_exempt_urls: 
+            '''The configuration for in-session inline redaction.
+
+            :param inline_redaction_patterns: The inline redaction patterns to be enabled for the inline redaction configuration.
+            :param global_confidence_level: The global confidence level for the inline redaction configuration. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This is applied to patterns that do not have a pattern-level confidence level. Defaults to confidence level 2.
+            :param global_enforced_urls: The global enforced URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level enforced URL list.
+            :param global_exempt_urls: The global exempt URL configuration for the inline redaction configuration. This is applied to patterns that do not have a pattern-level exempt URL list.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionconfiguration.html
             :exampleMetadata: fixture=_generated
@@ -809,7 +828,8 @@ class CfnDataProtectionSettings(
         def inline_redaction_patterns(
             self,
         ) -> typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnDataProtectionSettings.InlineRedactionPatternProperty"]]]:
-            '''
+            '''The inline redaction patterns to be enabled for the inline redaction configuration.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionconfiguration.html#cfn-workspacesweb-dataprotectionsettings-inlineredactionconfiguration-inlineredactionpatterns
             '''
             result = self._values.get("inline_redaction_patterns")
@@ -818,7 +838,10 @@ class CfnDataProtectionSettings(
 
         @builtins.property
         def global_confidence_level(self) -> typing.Optional[jsii.Number]:
-            '''
+            '''The global confidence level for the inline redaction configuration.
+
+            This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This is applied to patterns that do not have a pattern-level confidence level. Defaults to confidence level 2.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionconfiguration.html#cfn-workspacesweb-dataprotectionsettings-inlineredactionconfiguration-globalconfidencelevel
             '''
             result = self._values.get("global_confidence_level")
@@ -826,7 +849,10 @@ class CfnDataProtectionSettings(
 
         @builtins.property
         def global_enforced_urls(self) -> typing.Optional[typing.List[builtins.str]]:
-            '''
+            '''The global enforced URL configuration for the inline redaction configuration.
+
+            This is applied to patterns that do not have a pattern-level enforced URL list.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionconfiguration.html#cfn-workspacesweb-dataprotectionsettings-inlineredactionconfiguration-globalenforcedurls
             '''
             result = self._values.get("global_enforced_urls")
@@ -834,7 +860,10 @@ class CfnDataProtectionSettings(
 
         @builtins.property
         def global_exempt_urls(self) -> typing.Optional[typing.List[builtins.str]]:
-            '''
+            '''The global exempt URL configuration for the inline redaction configuration.
+
+            This is applied to patterns that do not have a pattern-level exempt URL list.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionconfiguration.html#cfn-workspacesweb-dataprotectionsettings-inlineredactionconfiguration-globalexempturls
             '''
             result = self._values.get("global_exempt_urls")
@@ -874,13 +903,14 @@ class CfnDataProtectionSettings(
             enforced_urls: typing.Optional[typing.Sequence[builtins.str]] = None,
             exempt_urls: typing.Optional[typing.Sequence[builtins.str]] = None,
         ) -> None:
-            '''
-            :param redaction_place_holder: 
-            :param built_in_pattern_id: 
-            :param confidence_level: 
-            :param custom_pattern: 
-            :param enforced_urls: 
-            :param exempt_urls: 
+            '''The set of patterns that determine the data types redacted in session.
+
+            :param redaction_place_holder: The redaction placeholder that will replace the redacted text in session for the inline redaction pattern.
+            :param built_in_pattern_id: The built-in pattern from the list of preconfigured patterns. Either a customPattern or builtInPatternId is required. To view the entire list of data types and their corresponding built-in pattern IDs, see `Base inline redaction <https://docs.aws.amazon.com/workspaces-web/latest/adminguide/base-inline-redaction.html>`_ .
+            :param confidence_level: The confidence level for inline redaction pattern. This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This overrides the global confidence level.
+            :param custom_pattern: The configuration for a custom pattern. Either a customPattern or builtInPatternId is required.
+            :param enforced_urls: The enforced URL configuration for the inline redaction pattern. This will override the global enforced URL configuration.
+            :param exempt_urls: The exempt URL configuration for the inline redaction pattern. This will override the global exempt URL configuration for the inline redaction pattern.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionpattern.html
             :exampleMetadata: fixture=_generated
@@ -940,7 +970,8 @@ class CfnDataProtectionSettings(
         def redaction_place_holder(
             self,
         ) -> typing.Union[_IResolvable_da3f097b, "CfnDataProtectionSettings.RedactionPlaceHolderProperty"]:
-            '''
+            '''The redaction placeholder that will replace the redacted text in session for the inline redaction pattern.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionpattern.html#cfn-workspacesweb-dataprotectionsettings-inlineredactionpattern-redactionplaceholder
             '''
             result = self._values.get("redaction_place_holder")
@@ -949,7 +980,10 @@ class CfnDataProtectionSettings(
 
         @builtins.property
         def built_in_pattern_id(self) -> typing.Optional[builtins.str]:
-            '''
+            '''The built-in pattern from the list of preconfigured patterns.
+
+            Either a customPattern or builtInPatternId is required. To view the entire list of data types and their corresponding built-in pattern IDs, see `Base inline redaction <https://docs.aws.amazon.com/workspaces-web/latest/adminguide/base-inline-redaction.html>`_ .
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionpattern.html#cfn-workspacesweb-dataprotectionsettings-inlineredactionpattern-builtinpatternid
             '''
             result = self._values.get("built_in_pattern_id")
@@ -957,7 +991,10 @@ class CfnDataProtectionSettings(
 
         @builtins.property
         def confidence_level(self) -> typing.Optional[jsii.Number]:
-            '''
+            '''The confidence level for inline redaction pattern.
+
+            This indicates the certainty of data type matches in the redaction process. Confidence level 3 means high confidence, and requires a formatted text pattern match in order for content to be redacted. Confidence level 2 means medium confidence, and redaction considers both formatted and unformatted text, and adds keyword associate to the logic. Confidence level 1 means low confidence, and redaction is enforced for both formatted pattern + unformatted pattern without keyword. This overrides the global confidence level.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionpattern.html#cfn-workspacesweb-dataprotectionsettings-inlineredactionpattern-confidencelevel
             '''
             result = self._values.get("confidence_level")
@@ -967,7 +1004,10 @@ class CfnDataProtectionSettings(
         def custom_pattern(
             self,
         ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataProtectionSettings.CustomPatternProperty"]]:
-            '''
+            '''The configuration for a custom pattern.
+
+            Either a customPattern or builtInPatternId is required.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionpattern.html#cfn-workspacesweb-dataprotectionsettings-inlineredactionpattern-custompattern
             '''
             result = self._values.get("custom_pattern")
@@ -975,7 +1015,10 @@ class CfnDataProtectionSettings(
 
         @builtins.property
         def enforced_urls(self) -> typing.Optional[typing.List[builtins.str]]:
-            '''
+            '''The enforced URL configuration for the inline redaction pattern.
+
+            This will override the global enforced URL configuration.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionpattern.html#cfn-workspacesweb-dataprotectionsettings-inlineredactionpattern-enforcedurls
             '''
             result = self._values.get("enforced_urls")
@@ -983,7 +1026,10 @@ class CfnDataProtectionSettings(
 
         @builtins.property
         def exempt_urls(self) -> typing.Optional[typing.List[builtins.str]]:
-            '''
+            '''The exempt URL configuration for the inline redaction pattern.
+
+            This will override the global exempt URL configuration for the inline redaction pattern.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionpattern.html#cfn-workspacesweb-dataprotectionsettings-inlineredactionpattern-exempturls
             '''
             result = self._values.get("exempt_urls")
@@ -1015,9 +1061,10 @@ class CfnDataProtectionSettings(
             redaction_place_holder_type: builtins.str,
             redaction_place_holder_text: typing.Optional[builtins.str] = None,
         ) -> None:
-            '''
-            :param redaction_place_holder_type: 
-            :param redaction_place_holder_text: 
+            '''The redaction placeholder that will replace the redacted text in session.
+
+            :param redaction_place_holder_type: The redaction placeholder type that will replace the redacted text in session.
+            :param redaction_place_holder_text: The redaction placeholder text that will replace the redacted text in session for the custom text redaction placeholder type.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-redactionplaceholder.html
             :exampleMetadata: fixture=_generated
@@ -1047,7 +1094,8 @@ class CfnDataProtectionSettings(
 
         @builtins.property
         def redaction_place_holder_type(self) -> builtins.str:
-            '''
+            '''The redaction placeholder type that will replace the redacted text in session.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-redactionplaceholder.html#cfn-workspacesweb-dataprotectionsettings-redactionplaceholder-redactionplaceholdertype
             '''
             result = self._values.get("redaction_place_holder_type")
@@ -1056,7 +1104,8 @@ class CfnDataProtectionSettings(
 
         @builtins.property
         def redaction_place_holder_text(self) -> typing.Optional[builtins.str]:
-            '''
+            '''The redaction placeholder text that will replace the redacted text in session for the custom text redaction placeholder type.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-redactionplaceholder.html#cfn-workspacesweb-dataprotectionsettings-redactionplaceholder-redactionplaceholdertext
             '''
             result = self._values.get("redaction_place_holder_text")
@@ -1099,12 +1148,12 @@ class CfnDataProtectionSettingsProps:
     ) -> None:
         '''Properties for defining a ``CfnDataProtectionSettings``.
 
-        :param additional_encryption_context: 
-        :param customer_managed_key: 
-        :param description: 
-        :param display_name: 
-        :param inline_redaction_configuration: 
-        :param tags: 
+        :param additional_encryption_context: The additional encryption context of the data protection settings.
+        :param customer_managed_key: The customer managed key used to encrypt sensitive information in the data protection settings.
+        :param description: The description of the data protection settings.
+        :param display_name: The display name of the data protection settings.
+        :param inline_redaction_configuration: The inline redaction configuration for the data protection settings.
+        :param tags: The tags of the data protection settings.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-dataprotectionsettings.html
         :exampleMetadata: fixture=_generated
@@ -1183,7 +1232,8 @@ class CfnDataProtectionSettingsProps:
     def additional_encryption_context(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]]:
-        '''
+        '''The additional encryption context of the data protection settings.
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-dataprotectionsettings.html#cfn-workspacesweb-dataprotectionsettings-additionalencryptioncontext
         '''
         result = self._values.get("additional_encryption_context")
@@ -1191,7 +1241,8 @@ class CfnDataProtectionSettingsProps:
 
     @builtins.property
     def customer_managed_key(self) -> typing.Optional[builtins.str]:
-        '''
+        '''The customer managed key used to encrypt sensitive information in the data protection settings.
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-dataprotectionsettings.html#cfn-workspacesweb-dataprotectionsettings-customermanagedkey
         '''
         result = self._values.get("customer_managed_key")
@@ -1199,7 +1250,8 @@ class CfnDataProtectionSettingsProps:
 
     @builtins.property
     def description(self) -> typing.Optional[builtins.str]:
-        '''
+        '''The description of the data protection settings.
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-dataprotectionsettings.html#cfn-workspacesweb-dataprotectionsettings-description
         '''
         result = self._values.get("description")
@@ -1207,7 +1259,8 @@ class CfnDataProtectionSettingsProps:
 
     @builtins.property
     def display_name(self) -> typing.Optional[builtins.str]:
-        '''
+        '''The display name of the data protection settings.
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-dataprotectionsettings.html#cfn-workspacesweb-dataprotectionsettings-displayname
         '''
         result = self._values.get("display_name")
@@ -1217,7 +1270,8 @@ class CfnDataProtectionSettingsProps:
     def inline_redaction_configuration(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnDataProtectionSettings.InlineRedactionConfigurationProperty]]:
-        '''
+        '''The inline redaction configuration for the data protection settings.
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-dataprotectionsettings.html#cfn-workspacesweb-dataprotectionsettings-inlineredactionconfiguration
         '''
         result = self._values.get("inline_redaction_configuration")
@@ -1225,7 +1279,8 @@ class CfnDataProtectionSettingsProps:
 
     @builtins.property
     def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
-        '''
+        '''The tags of the data protection settings.
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-dataprotectionsettings.html#cfn-workspacesweb-dataprotectionsettings-tags
         '''
         result = self._values.get("tags")
@@ -2443,7 +2498,7 @@ class CfnPortal(
         :param authentication_type: The type of authentication integration points used when signing into the web portal. Defaults to ``Standard`` . ``Standard`` web portals are authenticated directly through your identity provider (IdP). User and group access to your web portal is controlled through your IdP. You need to include an IdP resource in your template to integrate your IdP with your web portal. Completing the configuration for your IdP requires exchanging WorkSpaces Secure Browser’s SP metadata with your IdP’s IdP metadata. If your IdP requires the SP metadata first before returning the IdP metadata, you should follow these steps: 1. Create and deploy a CloudFormation template with a ``Standard`` portal with no ``IdentityProvider`` resource. 2. Retrieve the SP metadata using ``Fn:GetAtt`` , the WorkSpaces Secure Browser console, or by the calling the ``GetPortalServiceProviderMetadata`` API. 3. Submit the data to your IdP. 4. Add an ``IdentityProvider`` resource to your CloudFormation template. ``IAM Identity Center`` web portals are authenticated through AWS IAM Identity Center . They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration) and other identity provider information must be configured in IAM Identity Center . User and group assignment must be done through the WorkSpaces Secure Browser console. These cannot be configured in CloudFormation.
         :param browser_settings_arn: The ARN of the browser settings that is associated with this web portal.
         :param customer_managed_key: The customer managed key of the web portal. *Pattern* : ``^arn:[\\w+=\\/,.@-]+:kms:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:key\\/[a-zA-Z0-9-]+$``
-        :param data_protection_settings_arn: 
+        :param data_protection_settings_arn: The ARN of the data protection settings.
         :param display_name: The name of the web portal.
         :param instance_type: The type and resources of the underlying instance.
         :param ip_access_settings_arn: The ARN of the IP access settings that is associated with the web portal.
@@ -2653,6 +2708,7 @@ class CfnPortal(
     @builtins.property
     @jsii.member(jsii_name="dataProtectionSettingsArn")
     def data_protection_settings_arn(self) -> typing.Optional[builtins.str]:
+        '''The ARN of the data protection settings.'''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "dataProtectionSettingsArn"))
 
     @data_protection_settings_arn.setter
@@ -2831,7 +2887,7 @@ class CfnPortalProps:
         :param authentication_type: The type of authentication integration points used when signing into the web portal. Defaults to ``Standard`` . ``Standard`` web portals are authenticated directly through your identity provider (IdP). User and group access to your web portal is controlled through your IdP. You need to include an IdP resource in your template to integrate your IdP with your web portal. Completing the configuration for your IdP requires exchanging WorkSpaces Secure Browser’s SP metadata with your IdP’s IdP metadata. If your IdP requires the SP metadata first before returning the IdP metadata, you should follow these steps: 1. Create and deploy a CloudFormation template with a ``Standard`` portal with no ``IdentityProvider`` resource. 2. Retrieve the SP metadata using ``Fn:GetAtt`` , the WorkSpaces Secure Browser console, or by the calling the ``GetPortalServiceProviderMetadata`` API. 3. Submit the data to your IdP. 4. Add an ``IdentityProvider`` resource to your CloudFormation template. ``IAM Identity Center`` web portals are authenticated through AWS IAM Identity Center . They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration) and other identity provider information must be configured in IAM Identity Center . User and group assignment must be done through the WorkSpaces Secure Browser console. These cannot be configured in CloudFormation.
         :param browser_settings_arn: The ARN of the browser settings that is associated with this web portal.
         :param customer_managed_key: The customer managed key of the web portal. *Pattern* : ``^arn:[\\w+=\\/,.@-]+:kms:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:key\\/[a-zA-Z0-9-]+$``
-        :param data_protection_settings_arn: 
+        :param data_protection_settings_arn: The ARN of the data protection settings.
         :param display_name: The name of the web portal.
         :param instance_type: The type and resources of the underlying instance.
         :param ip_access_settings_arn: The ARN of the IP access settings that is associated with the web portal.
@@ -2970,7 +3026,8 @@ class CfnPortalProps:
 
     @builtins.property
     def data_protection_settings_arn(self) -> typing.Optional[builtins.str]:
-        '''
+        '''The ARN of the data protection settings.
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-portal.html#cfn-workspacesweb-portal-dataprotectionsettingsarn
         '''
         result = self._values.get("data_protection_settings_arn")

{aws_cdk_lib-2.172.0.dist-info → aws_cdk_lib-2.173.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aws-cdk-lib
-Version: 2.172.0
+Version: 2.173.1
 Summary: Version 2 of the AWS Cloud Development Kit library
 Home-page: https://github.com/aws/aws-cdk
 Author: Amazon Web Services