CfnCustomDataIdentifierProps

class aws_cdk.aws_macie.CfnCustomDataIdentifierProps(*, name, regex, description=None, ignore_words=None, keywords=None, maximum_match_distance=None)

Bases: object

Properties for defining a CfnCustomDataIdentifier.

Parameters
  • name (str) – A custom name for the custom data identifier. The name can contain as many as 128 characters. We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see the identifier’s name, depending on the actions that they’re allowed to perform in Amazon Macie .

  • regex (str) – The regular expression ( regex ) that defines the pattern to match. The expression can contain as many as 512 characters.

  • description (Optional[str]) – The description of the custom data identifier. The description can contain as many as 512 characters.

  • ignore_words (Optional[Sequence[str]]) – An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 characters. Ignore words are case sensitive.

  • keywords (Optional[Sequence[str]]) – An array that lists specific character sequences (keywords), one of which must be within proximity ( MaximumMatchDistance ) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 characters. Keywords aren’t case sensitive.

  • maximum_match_distance (Union[int, float, None]) – The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the Keywords array. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1-300 characters. The default value is 50.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_macie as macie

cfn_custom_data_identifier_props = macie.CfnCustomDataIdentifierProps(
    name="name",
    regex="regex",

    # the properties below are optional
    description="description",
    ignore_words=["ignoreWords"],
    keywords=["keywords"],
    maximum_match_distance=123
)

Attributes

description

The description of the custom data identifier.

The description can contain as many as 512 characters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-description

Return type

Optional[str]

ignore_words

An array that lists specific character sequences (ignore words) to exclude from the results.

If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 characters. Ignore words are case sensitive.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-ignorewords

Return type

Optional[List[str]]

keywords

An array that lists specific character sequences (keywords), one of which must be within proximity ( MaximumMatchDistance ) of the regular expression to match.

The array can contain as many as 50 keywords. Each keyword can contain 3-90 characters. Keywords aren’t case sensitive.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-keywords

Return type

Optional[List[str]]

maximum_match_distance

The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the Keywords array.

Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1-300 characters. The default value is 50.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-maximummatchdistance

Return type

Union[int, float, None]

name

A custom name for the custom data identifier. The name can contain as many as 128 characters.

We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see the identifier’s name, depending on the actions that they’re allowed to perform in Amazon Macie .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-name

Return type

str

regex

The regular expression ( regex ) that defines the pattern to match.

The expression can contain as many as 512 characters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-regex

Return type

str