aws-cdk-lib.aws_workspacesweb.CfnDataProtectionSettings.InlineRedactionConfigurationProperty

InlineRedactionConfigurationProperty Struct

The configuration for in-session inline redaction.

Source

Generated code

Type last changed

v2.172.0 · 7 Dec 2024

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_workspacesweb as workspacesweb } from 'aws-cdk-lib';
const inlineRedactionConfigurationProperty: workspacesweb.CfnDataProtectionSettings.InlineRedactionConfigurationProperty = {
  inlineRedactionPatterns: [{
    redactionPlaceHolder: {
      redactionPlaceHolderType: 'redactionPlaceHolderType',

      // the properties below are optional
      redactionPlaceHolderText: 'redactionPlaceHolderText',
    },

    // the properties below are optional
    builtInPatternId: 'builtInPatternId',
    confidenceLevel: 123,
    customPattern: {
      patternName: 'patternName',
      patternRegex: 'patternRegex',

      // the properties below are optional
      keywordRegex: 'keywordRegex',
      patternDescription: 'patternDescription',
    },
    enforcedUrls: ['enforcedUrls'],
    exemptUrls: ['exemptUrls'],
  }],

  // the properties below are optional
  globalConfidenceLevel: 123,
  globalEnforcedUrls: ['globalEnforcedUrls'],
  globalExemptUrls: ['globalExemptUrls'],
};

Properties

globalConfidenceLevel?optionalnumberglobal_confidence_level?optionalint | floatglobalConfidenceLevel?optionalNumberGlobalConfidenceLevel?optionaldoubleGlobalConfidenceLevel?optional*float64#

The global confidence level for the inline redaction configuration.

notes

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.

globalEnforcedUrls?optionalstring[]global_enforced_urls?optionaltyping.List[str]globalEnforcedUrls?optionalList<String>GlobalEnforcedUrls?optionalstring[]GlobalEnforcedUrls?optional*[]*string#

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.

globalExemptUrls?optionalstring[]global_exempt_urls?optionaltyping.List[str]globalExemptUrls?optionalList<String>GlobalExemptUrls?optionalstring[]GlobalExemptUrls?optional*[]*string#

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.

inlineRedactionPatternsIResolvable | IResolvable | CfnDataProtectionSettings.InlineRedactionPatternProperty[]inline_redaction_patternstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, InlineRedactionPatternProperty]]]inlineRedactionPatternsIResolvableInlineRedactionPatternsIResolvableInlineRedactionPatternsinterface{}required#

The inline redaction patterns to be enabled for the inline redaction configuration.