# InlineRedactionConfigurationProperty

The configuration for in-session inline redaction.

- Source: Generated at build time
- Type last changed: v2.172.0 · 7 Dec 2024

## Example

TypeScript:

```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 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'],
};
```

Python:

```python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_workspacesweb as workspacesweb

inline_redaction_configuration_property = workspacesweb.CfnDataProtectionSettings.InlineRedactionConfigurationProperty(
    inline_redaction_patterns=[workspacesweb.CfnDataProtectionSettings.InlineRedactionPatternProperty(
        redaction_place_holder=workspacesweb.CfnDataProtectionSettings.RedactionPlaceHolderProperty(
            redaction_place_holder_type="redactionPlaceHolderType",

            # the properties below are optional
            redaction_place_holder_text="redactionPlaceHolderText"
        ),

        # the properties below are optional
        built_in_pattern_id="builtInPatternId",
        confidence_level=123,
        custom_pattern=workspacesweb.CfnDataProtectionSettings.CustomPatternProperty(
            pattern_name="patternName",
            pattern_regex="patternRegex",

            # the properties below are optional
            keyword_regex="keywordRegex",
            pattern_description="patternDescription"
        ),
        enforced_urls=["enforcedUrls"],
        exempt_urls=["exemptUrls"]
    )],

    # the properties below are optional
    global_confidence_level=123,
    global_enforced_urls=["globalEnforcedUrls"],
    global_exempt_urls=["globalExemptUrls"]
)
```

Java:

```java
// 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.*;

InlineRedactionConfigurationProperty inlineRedactionConfigurationProperty = 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();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.WorkSpacesWeb;

var inlineRedactionConfigurationProperty = new InlineRedactionConfigurationProperty {
    InlineRedactionPatterns = new [] { new InlineRedactionPatternProperty {
        RedactionPlaceHolder = new RedactionPlaceHolderProperty {
            RedactionPlaceHolderType = "redactionPlaceHolderType",

            // the properties below are optional
            RedactionPlaceHolderText = "redactionPlaceHolderText"
        },

        // the properties below are optional
        BuiltInPatternId = "builtInPatternId",
        ConfidenceLevel = 123,
        CustomPattern = new CustomPatternProperty {
            PatternName = "patternName",
            PatternRegex = "patternRegex",

            // the properties below are optional
            KeywordRegex = "keywordRegex",
            PatternDescription = "patternDescription"
        },
        EnforcedUrls = new [] { "enforcedUrls" },
        ExemptUrls = new [] { "exemptUrls" }
    } },

    // the properties below are optional
    GlobalConfidenceLevel = 123,
    GlobalEnforcedUrls = new [] { "globalEnforcedUrls" },
    GlobalExemptUrls = new [] { "globalExemptUrls" }
};
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

inlineRedactionConfigurationProperty := &InlineRedactionConfigurationProperty{
	InlineRedactionPatterns: []interface{}{
		&InlineRedactionPatternProperty{
			RedactionPlaceHolder: &RedactionPlaceHolderProperty{
				RedactionPlaceHolderType: jsii.String("redactionPlaceHolderType"),

				// the properties below are optional
				RedactionPlaceHolderText: jsii.String("redactionPlaceHolderText"),
			},

			// the properties below are optional
			BuiltInPatternId: jsii.String("builtInPatternId"),
			ConfidenceLevel: jsii.Number(123),
			CustomPattern: &CustomPatternProperty{
				PatternName: jsii.String("patternName"),
				PatternRegex: jsii.String("patternRegex"),

				// the properties below are optional
				KeywordRegex: jsii.String("keywordRegex"),
				PatternDescription: jsii.String("patternDescription"),
			},
			EnforcedUrls: []*string{
				jsii.String("enforcedUrls"),
			},
			ExemptUrls: []*string{
				jsii.String("exemptUrls"),
			},
		},
	},

	// the properties below are optional
	GlobalConfidenceLevel: jsii.Number(123),
	GlobalEnforcedUrls: []*string{
		jsii.String("globalEnforcedUrls"),
	},
	GlobalExemptUrls: []*string{
		jsii.String("globalExemptUrls"),
	},
}
```

## Properties

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

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

- `inlineRedactionPatterns`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDataProtectionSettings.InlineRedactionPatternProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_workspacesweb.CfnDataProtectionSettings.InlineRedactionPatternProperty.html)[] (required) — The inline redaction patterns to be enabled for the inline redaction configuration.
