Skip to content
v2.277.0

InlineRedactionPatternProperty Struct ​

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

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'],
};
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_pattern_property = 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"]
)
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.*;

InlineRedactionPatternProperty inlineRedactionPatternProperty = 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();
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 inlineRedactionPatternProperty = 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" }
};
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"

inlineRedactionPatternProperty := &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"),
	},
}

Properties ​

builtInPatternIdoptionalstringbuilt_in_pattern_idoptionalstrbuiltInPatternIdoptionalStringBuiltInPatternIdoptionalstringBuiltInPatternIdoptional*string #
The built-in pattern from the list of preconfigured patterns.
notes

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 .

confidenceLeveloptionalnumberconfidence_leveloptionalint | floatconfidenceLeveloptionalNumberConfidenceLeveloptionaldoubleConfidenceLeveloptional*float64 #
The confidence level for inline redaction pattern.
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 overrides the global confidence level.

customPatternoptionalIResolvable | CfnDataProtectionSettings.CustomPatternPropertycustom_patternoptionaltyping.Union[IResolvable, CustomPatternProperty]customPatternoptionalIResolvableCustomPatternoptionalIResolvableCustomPatternoptionalinterface{} #
The configuration for a custom pattern.

Either a customPattern or builtInPatternId is required.

enforcedUrlsoptionalstring[]enforced_urlsoptionaltyping.List[str]enforcedUrlsoptionalList<String>EnforcedUrlsoptionalstring[]EnforcedUrlsoptional*[]*string #
The enforced URL configuration for the inline redaction pattern.

This will override the global enforced URL configuration.

exemptUrlsoptionalstring[]exempt_urlsoptionaltyping.List[str]exemptUrlsoptionalList<String>ExemptUrlsoptionalstring[]ExemptUrlsoptional*[]*string #
The exempt URL configuration for the inline redaction pattern.

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

redactionPlaceHolderIResolvable | CfnDataProtectionSettings.RedactionPlaceHolderPropertyredaction_place_holdertyping.Union[IResolvable, RedactionPlaceHolderProperty]redactionPlaceHolderIResolvableRedactionPlaceHolderIResolvableRedactionPlaceHolderinterface{} required #
The redaction placeholder that will replace the redacted text in session for the inline redaction pattern.