Package software.amazon.awscdk.services.workspacesweb

Class CfnDataProtectionSettings

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.CfnDataProtectionSettings
All Implemented Interfaces:
IInspectable, ITaggableV2, IDataProtectionSettingsRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:50.702Z") @Stability(Stable) public class CfnDataProtectionSettings extends CfnResource implements IInspectable, IDataProtectionSettingsRef, ITaggableV2
The data protection settings resource that can be associated with a web portal.

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.*;
 CfnDataProtectionSettings cfnDataProtectionSettings = CfnDataProtectionSettings.Builder.create(this, "MyCfnDataProtectionSettings")
         .additionalEncryptionContext(Map.of(
                 "additionalEncryptionContextKey", "additionalEncryptionContext"))
         .customerManagedKey("customerManagedKey")
         .description("description")
         .displayName("displayName")
         .inlineRedactionConfiguration(InlineRedactionConfigurationProperty.builder()
                 .inlineRedactionPatterns(List.of(InlineRedactionPatternProperty.builder()
                         .redactionPlaceHolder(RedactionPlaceHolderProperty.builder()
                                 .redactionPlaceHolderType("redactionPlaceHolderType")
                                 // the properties below are optional
                                 .redactionPlaceHolderText("redactionPlaceHolderText")
                                 .build())
                         // the properties below are optional
                         .builtInPatternId("builtInPatternId")
                         .confidenceLevel(123)
                         .customPattern(CustomPatternProperty.builder()
                                 .patternName("patternName")
                                 .patternRegex("patternRegex")
                                 // the properties below are optional
                                 .keywordRegex("keywordRegex")
                                 .patternDescription("patternDescription")
                                 .build())
                         .enforcedUrls(List.of("enforcedUrls"))
                         .exemptUrls(List.of("exemptUrls"))
                         .build()))
                 // the properties below are optional
                 .globalConfidenceLevel(123)
                 .globalEnforcedUrls(List.of("globalEnforcedUrls"))
                 .globalExemptUrls(List.of("globalExemptUrls"))
                 .build())
         .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

    • CfnDataProtectionSettings

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

    • CfnDataProtectionSettings

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

    • CfnDataProtectionSettings

      @Stability(Stable) public CfnDataProtectionSettings(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnDataProtectionSettingsProps 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.

    • CfnDataProtectionSettings

      @Stability(Stable) public CfnDataProtectionSettings(@NotNull software.constructs.Construct scope, @NotNull String id)
      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.

  • 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 data protection settings resource is associated with.

    • getAttrCreationDate

      @Stability(Stable) @NotNull public String getAttrCreationDate()
      The creation date timestamp of the data protection settings.

    • getAttrDataProtectionSettingsArn

      @Stability(Stable) @NotNull public String getAttrDataProtectionSettingsArn()
      The ARN of the data protection settings resource.

    • 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

    • getDataProtectionSettingsRef

      @Stability(Stable) @NotNull public DataProtectionSettingsReference getDataProtectionSettingsRef()
      A reference to a DataProtectionSettings resource.
      Specified by:
      getDataProtectionSettingsRef in interface IDataProtectionSettingsRef

    • getAdditionalEncryptionContext

      @Stability(Stable) @Nullable public Object getAdditionalEncryptionContext()
      The additional encryption context of the data protection settings.

      Returns union: either Mapinvalid input: '<'String, String> or IResolvable

    • setAdditionalEncryptionContext

      @Stability(Stable) public void setAdditionalEncryptionContext(@Nullable Map<String,String> value)
      The additional encryption context of the data protection settings.

    • setAdditionalEncryptionContext

      @Stability(Stable) public void setAdditionalEncryptionContext(@Nullable IResolvable value)
      The additional encryption context of the data protection settings.

    • getCustomerManagedKey

      @Stability(Stable) @Nullable public String getCustomerManagedKey()
      The customer managed key used to encrypt sensitive information in the data protection settings.

    • setCustomerManagedKey

      @Stability(Stable) public void setCustomerManagedKey(@Nullable String value)
      The customer managed key used to encrypt sensitive information in the data protection settings.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the data protection settings.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the data protection settings.

    • getDisplayName

      @Stability(Stable) @Nullable public String getDisplayName()
      The display name of the data protection settings.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@Nullable String value)
      The display name of the data protection settings.

    • getInlineRedactionConfiguration

      @Stability(Stable) @Nullable public Object getInlineRedactionConfiguration()
      The inline redaction configuration for the data protection settings.

      Returns union: either IResolvable or CfnDataProtectionSettings.InlineRedactionConfigurationProperty

    • setInlineRedactionConfiguration

      @Stability(Stable) public void setInlineRedactionConfiguration(@Nullable IResolvable value)
      The inline redaction configuration for the data protection settings.

    • setInlineRedactionConfiguration

      @Stability(Stable) public void setInlineRedactionConfiguration(@Nullable CfnDataProtectionSettings.InlineRedactionConfigurationProperty value)
      The inline redaction configuration for the data protection settings.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags of the data protection settings.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags of the data protection settings.