# InlineRedactionPatternProperty

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

- Source: Generated code
- Type last changed: v2.172.0 · 7 Dec 2024

## Example

```ts
// 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 inlineRedactionPatternProperty: workspacesweb.CfnDataProtectionSettings.InlineRedactionPatternProperty = {
  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'],
};
```

## Properties

- `builtInPatternId`: string — 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) .

- `confidenceLevel`: 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.

- `customPattern`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDataProtectionSettings.CustomPatternProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnDataProtectionSettings.CustomPatternProperty.html) — The configuration for a custom pattern.

  Either a customPattern or builtInPatternId is required.

- `enforcedUrls`: string[] — The enforced URL configuration for the inline redaction pattern.

  This will override the global enforced URL configuration.

- `exemptUrls`: string[] — The exempt URL configuration for the inline redaction pattern.

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

- `redactionPlaceHolder`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDataProtectionSettings.RedactionPlaceHolderProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnDataProtectionSettings.RedactionPlaceHolderProperty.html) (required) — The redaction placeholder that will replace the redacted text in session for the inline redaction pattern.