CfnDataProtectionSettingsPropsMixin

class aws_cdk.mixins_preview.aws_workspacesweb.mixins.CfnDataProtectionSettingsPropsMixin(props, *, strategy=None)

Bases: Mixin

The data protection settings resource that can be associated with a web portal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-dataprotectionsettings.html

CloudformationResource:

AWS::WorkSpacesWeb::DataProtectionSettings

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

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

cfn_data_protection_settings_props_mixin = workspacesweb_mixins.CfnDataProtectionSettingsPropsMixin(workspacesweb_mixins.CfnDataProtectionSettingsMixinProps(
    additional_encryption_context={
        "additional_encryption_context_key": "additionalEncryptionContext"
    },
    customer_managed_key="customerManagedKey",
    description="description",
    display_name="displayName",
    inline_redaction_configuration=workspacesweb_mixins.CfnDataProtectionSettingsPropsMixin.InlineRedactionConfigurationProperty(
        global_confidence_level=123,
        global_enforced_urls=["globalEnforcedUrls"],
        global_exempt_urls=["globalExemptUrls"],
        inline_redaction_patterns=[workspacesweb_mixins.CfnDataProtectionSettingsPropsMixin.InlineRedactionPatternProperty(
            built_in_pattern_id="builtInPatternId",
            confidence_level=123,
            custom_pattern=workspacesweb_mixins.CfnDataProtectionSettingsPropsMixin.CustomPatternProperty(
                keyword_regex="keywordRegex",
                pattern_description="patternDescription",
                pattern_name="patternName",
                pattern_regex="patternRegex"
            ),
            enforced_urls=["enforcedUrls"],
            exempt_urls=["exemptUrls"],
            redaction_place_holder=workspacesweb_mixins.CfnDataProtectionSettingsPropsMixin.RedactionPlaceHolderProperty(
                redaction_place_holder_text="redactionPlaceHolderText",
                redaction_place_holder_type="redactionPlaceHolderType"
            )
        )]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::WorkSpacesWeb::DataProtectionSettings.

Parameters:

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['additionalEncryptionContext', 'customerManagedKey', 'description', 'displayName', 'inlineRedactionConfiguration', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

CustomPatternProperty

class CfnDataProtectionSettingsPropsMixin.CustomPatternProperty(*, keyword_regex=None, pattern_description=None, pattern_name=None, pattern_regex=None)

Bases: object

The pattern configuration for redacting custom data types in session.

Parameters:

  • keyword_regex (Optional[str]) – The keyword regex for the customer pattern. After there is a match to the pattern regex, the keyword regex is used to search within the proximity of the match. If there is a keyword match, then the match is confirmed. If no keyword regex is provided, the pattern regex match will automatically be confirmed. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example, “/ab+c/gi”

  • pattern_description (Optional[str]) – The pattern description for the customer pattern.

  • pattern_name (Optional[str]) – The pattern name for the custom pattern.

  • pattern_regex (Optional[str]) – The pattern regex for the customer pattern. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example: “/ab+c/gi”.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-custompattern.html

ExampleMetadata:

fixture=_generated

Example:

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

custom_pattern_property = workspacesweb_mixins.CfnDataProtectionSettingsPropsMixin.CustomPatternProperty(
    keyword_regex="keywordRegex",
    pattern_description="patternDescription",
    pattern_name="patternName",
    pattern_regex="patternRegex"
)

Attributes

keyword_regex

The keyword regex for the customer pattern.

After there is a match to the pattern regex, the keyword regex is used to search within the proximity of the match. If there is a keyword match, then the match is confirmed. If no keyword regex is provided, the pattern regex match will automatically be confirmed. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example, “/ab+c/gi”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-custompattern.html#cfn-workspacesweb-dataprotectionsettings-custompattern-keywordregex

pattern_description

The pattern description for the customer pattern.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-custompattern.html#cfn-workspacesweb-dataprotectionsettings-custompattern-patterndescription

pattern_name

The pattern name for the custom pattern.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-custompattern.html#cfn-workspacesweb-dataprotectionsettings-custompattern-patternname

pattern_regex

The pattern regex for the customer pattern.

The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example: “/ab+c/gi”.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-custompattern.html#cfn-workspacesweb-dataprotectionsettings-custompattern-patternregex

InlineRedactionConfigurationProperty

class CfnDataProtectionSettingsPropsMixin.InlineRedactionConfigurationProperty(*, global_confidence_level=None, global_enforced_urls=None, global_exempt_urls=None, inline_redaction_patterns=None)

Bases: object

The configuration for in-session inline redaction.

Parameters:

  • global_confidence_level (Union[int, float, None]) – 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.

  • global_enforced_urls (Optional[Sequence[str]]) – 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.

  • global_exempt_urls (Optional[Sequence[str]]) – 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.

  • inline_redaction_patterns (Union[IResolvable, Sequence[Union[IResolvable, InlineRedactionPatternProperty, Dict[str, Any]]], None]) – The inline redaction patterns to be enabled for the inline redaction configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

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

inline_redaction_configuration_property = workspacesweb_mixins.CfnDataProtectionSettingsPropsMixin.InlineRedactionConfigurationProperty(
    global_confidence_level=123,
    global_enforced_urls=["globalEnforcedUrls"],
    global_exempt_urls=["globalExemptUrls"],
    inline_redaction_patterns=[workspacesweb_mixins.CfnDataProtectionSettingsPropsMixin.InlineRedactionPatternProperty(
        built_in_pattern_id="builtInPatternId",
        confidence_level=123,
        custom_pattern=workspacesweb_mixins.CfnDataProtectionSettingsPropsMixin.CustomPatternProperty(
            keyword_regex="keywordRegex",
            pattern_description="patternDescription",
            pattern_name="patternName",
            pattern_regex="patternRegex"
        ),
        enforced_urls=["enforcedUrls"],
        exempt_urls=["exemptUrls"],
        redaction_place_holder=workspacesweb_mixins.CfnDataProtectionSettingsPropsMixin.RedactionPlaceHolderProperty(
            redaction_place_holder_text="redactionPlaceHolderText",
            redaction_place_holder_type="redactionPlaceHolderType"
        )
    )]
)

Attributes

global_confidence_level

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionconfiguration.html#cfn-workspacesweb-dataprotectionsettings-inlineredactionconfiguration-globalconfidencelevel

global_enforced_urls

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionconfiguration.html#cfn-workspacesweb-dataprotectionsettings-inlineredactionconfiguration-globalenforcedurls

global_exempt_urls

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionconfiguration.html#cfn-workspacesweb-dataprotectionsettings-inlineredactionconfiguration-globalexempturls

inline_redaction_patterns

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionconfiguration.html#cfn-workspacesweb-dataprotectionsettings-inlineredactionconfiguration-inlineredactionpatterns

InlineRedactionPatternProperty

class CfnDataProtectionSettingsPropsMixin.InlineRedactionPatternProperty(*, built_in_pattern_id=None, confidence_level=None, custom_pattern=None, enforced_urls=None, exempt_urls=None, redaction_place_holder=None)

Bases: object

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

Parameters:

  • built_in_pattern_id (Optional[str]) – 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 .

  • confidence_level (Union[int, float, None]) – 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.

  • custom_pattern (Union[IResolvable, CustomPatternProperty, Dict[str, Any], None]) – The configuration for a custom pattern. Either a customPattern or builtInPatternId is required.

  • enforced_urls (Optional[Sequence[str]]) – The enforced URL configuration for the inline redaction pattern. This will override the global enforced URL configuration.

  • exempt_urls (Optional[Sequence[str]]) – The exempt URL configuration for the inline redaction pattern. This will override the global exempt URL configuration for the inline redaction pattern.

  • redaction_place_holder (Union[IResolvable, RedactionPlaceHolderProperty, Dict[str, Any], None]) – The redaction placeholder that will replace the redacted text in session for the inline redaction pattern.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionpattern.html

ExampleMetadata:

fixture=_generated

Example:

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

inline_redaction_pattern_property = workspacesweb_mixins.CfnDataProtectionSettingsPropsMixin.InlineRedactionPatternProperty(
    built_in_pattern_id="builtInPatternId",
    confidence_level=123,
    custom_pattern=workspacesweb_mixins.CfnDataProtectionSettingsPropsMixin.CustomPatternProperty(
        keyword_regex="keywordRegex",
        pattern_description="patternDescription",
        pattern_name="patternName",
        pattern_regex="patternRegex"
    ),
    enforced_urls=["enforcedUrls"],
    exempt_urls=["exemptUrls"],
    redaction_place_holder=workspacesweb_mixins.CfnDataProtectionSettingsPropsMixin.RedactionPlaceHolderProperty(
        redaction_place_holder_text="redactionPlaceHolderText",
        redaction_place_holder_type="redactionPlaceHolderType"
    )
)

Attributes

built_in_pattern_id

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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionpattern.html#cfn-workspacesweb-dataprotectionsettings-inlineredactionpattern-builtinpatternid

confidence_level

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionpattern.html#cfn-workspacesweb-dataprotectionsettings-inlineredactionpattern-confidencelevel

custom_pattern

The configuration for a custom pattern.

Either a customPattern or builtInPatternId is required.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionpattern.html#cfn-workspacesweb-dataprotectionsettings-inlineredactionpattern-custompattern

enforced_urls

The enforced URL configuration for the inline redaction pattern.

This will override the global enforced URL configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionpattern.html#cfn-workspacesweb-dataprotectionsettings-inlineredactionpattern-enforcedurls

exempt_urls

The exempt URL configuration for the inline redaction pattern.

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionpattern.html#cfn-workspacesweb-dataprotectionsettings-inlineredactionpattern-exempturls

redaction_place_holder

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-inlineredactionpattern.html#cfn-workspacesweb-dataprotectionsettings-inlineredactionpattern-redactionplaceholder

RedactionPlaceHolderProperty

class CfnDataProtectionSettingsPropsMixin.RedactionPlaceHolderProperty(*, redaction_place_holder_text=None, redaction_place_holder_type=None)

Bases: object

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

Parameters:

  • redaction_place_holder_text (Optional[str]) – The redaction placeholder text that will replace the redacted text in session for the custom text redaction placeholder type.

  • redaction_place_holder_type (Optional[str]) – The redaction placeholder type that will replace the redacted text in session.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-redactionplaceholder.html

ExampleMetadata:

fixture=_generated

Example:

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

redaction_place_holder_property = workspacesweb_mixins.CfnDataProtectionSettingsPropsMixin.RedactionPlaceHolderProperty(
    redaction_place_holder_text="redactionPlaceHolderText",
    redaction_place_holder_type="redactionPlaceHolderType"
)

Attributes

redaction_place_holder_text

The redaction placeholder text that will replace the redacted text in session for the custom text redaction placeholder type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-redactionplaceholder.html#cfn-workspacesweb-dataprotectionsettings-redactionplaceholder-redactionplaceholdertext

redaction_place_holder_type

The redaction placeholder type that will replace the redacted text in session.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-dataprotectionsettings-redactionplaceholder.html#cfn-workspacesweb-dataprotectionsettings-redactionplaceholder-redactionplaceholdertype