Class: AWSCDK::WorkspacesWeb::CfnDataProtectionSettings::InlineRedactionPatternProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
workspaces_web/cfn_data_protection_settings.rb

Overview

The set of patterns that determine the data types redacted in session.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(redaction_place_holder:, built_in_pattern_id: nil, confidence_level: nil, custom_pattern: nil, enforced_urls: nil, exempt_urls: nil) ⇒ InlineRedactionPatternProperty

Returns a new instance of InlineRedactionPatternProperty.

Parameters:



740
741
742
743
744
745
746
747
748
749
750
751
752
753
 
# File 'workspaces_web/cfn_data_protection_settings.rb', line 740

def initialize(redaction_place_holder:, built_in_pattern_id: nil, confidence_level: nil, custom_pattern: nil, enforced_urls: nil, exempt_urls: nil)
  @redaction_place_holder = redaction_place_holder.is_a?(Hash) ? ::AWSCDK::WorkspacesWeb::CfnDataProtectionSettings::RedactionPlaceHolderProperty.new(**redaction_place_holder.transform_keys(&:to_sym)) : redaction_place_holder
  Jsii::Type.check_type(@redaction_place_holder, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193b3Jrc3BhY2Vzd2ViLkNmbkRhdGFQcm90ZWN0aW9uU2V0dGluZ3MuUmVkYWN0aW9uUGxhY2VIb2xkZXJQcm9wZXJ0eSJ9XX19")), "redactionPlaceHolder")
  @built_in_pattern_id = built_in_pattern_id
  Jsii::Type.check_type(@built_in_pattern_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "builtInPatternId") unless @built_in_pattern_id.nil?
  @confidence_level = confidence_level
  Jsii::Type.check_type(@confidence_level, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "confidenceLevel") unless @confidence_level.nil?
  @custom_pattern = custom_pattern.is_a?(Hash) ? ::AWSCDK::WorkspacesWeb::CfnDataProtectionSettings::CustomPatternProperty.new(**custom_pattern.transform_keys(&:to_sym)) : custom_pattern
  Jsii::Type.check_type(@custom_pattern, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193b3Jrc3BhY2Vzd2ViLkNmbkRhdGFQcm90ZWN0aW9uU2V0dGluZ3MuQ3VzdG9tUGF0dGVyblByb3BlcnR5In1dfX0=")), "customPattern") unless @custom_pattern.nil?
  @enforced_urls = enforced_urls
  Jsii::Type.check_type(@enforced_urls, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "enforcedUrls") unless @enforced_urls.nil?
  @exempt_urls = exempt_urls
  Jsii::Type.check_type(@exempt_urls, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "exemptUrls") unless @exempt_urls.nil?
end

Instance Attribute Details

#built_in_pattern_id ⇒ String? (readonly)

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 .

Returns:

  • (String, nil)

See Also:



766
767
768
 
# File 'workspaces_web/cfn_data_protection_settings.rb', line 766

def built_in_pattern_id
  @built_in_pattern_id
end

#confidence_level ⇒ Numeric? (readonly)

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.

Returns:

  • (Numeric, nil)

See Also:



773
774
775
 
# File 'workspaces_web/cfn_data_protection_settings.rb', line 773

def confidence_level
  @confidence_level
end

#custom_pattern ⇒ AWSCDK::IResolvable, ... (readonly)

The configuration for a custom pattern.

Either a customPattern or builtInPatternId is required.

Returns:

See Also:



780
781
782
 
# File 'workspaces_web/cfn_data_protection_settings.rb', line 780

def custom_pattern
  @custom_pattern
end

#enforced_urls ⇒ Array<String>? (readonly)

The enforced URL configuration for the inline redaction pattern.

This will override the global enforced URL configuration.

Returns:

  • (Array<String>, nil)

See Also:



787
788
789
 
# File 'workspaces_web/cfn_data_protection_settings.rb', line 787

def enforced_urls
  @enforced_urls
end

#exempt_urls ⇒ Array<String>? (readonly)

The exempt URL configuration for the inline redaction pattern.

This will override the global exempt URL configuration for the inline redaction pattern.

Returns:

  • (Array<String>, nil)

See Also:



794
795
796
 
# File 'workspaces_web/cfn_data_protection_settings.rb', line 794

def exempt_urls
  @exempt_urls
end

#redaction_place_holder ⇒ AWSCDK::IResolvable, AWSCDK::WorkspacesWeb::CfnDataProtectionSettings::RedactionPlaceHolderProperty (readonly)

The redaction placeholder that will replace the redacted text in session for the inline redaction pattern.

Returns:

See Also:



759
760
761
 
# File 'workspaces_web/cfn_data_protection_settings.rb', line 759

def redaction_place_holder
  @redaction_place_holder
end

Class Method Details

.jsii_properties ⇒ Object 



796
797
798
799
800
801
802
803
804
805
 
# File 'workspaces_web/cfn_data_protection_settings.rb', line 796

def self.jsii_properties
  {
    :redaction_place_holder => "redactionPlaceHolder",
    :built_in_pattern_id => "builtInPatternId",
    :confidence_level => "confidenceLevel",
    :custom_pattern => "customPattern",
    :enforced_urls => "enforcedUrls",
    :exempt_urls => "exemptUrls",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'workspaces_web/cfn_data_protection_settings.rb', line 807

def to_jsii
  result = {}
  result.merge!({
    "redactionPlaceHolder" => @redaction_place_holder,
    "builtInPatternId" => @built_in_pattern_id,
    "confidenceLevel" => @confidence_level,
    "customPattern" => @custom_pattern,
    "enforcedUrls" => @enforced_urls,
    "exemptUrls" => @exempt_urls,
  })
  result.compact
end