Interface ICfnCustomDataIdentifierProps
Properties for defining a CfnCustomDataIdentifier
.
Namespace: Amazon.CDK.AWS.Macie
Assembly: Amazon.CDK.AWS.Macie.dll
Syntax (csharp)
public interface ICfnCustomDataIdentifierProps
Syntax (vb)
Public Interface ICfnCustomDataIdentifierProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Macie;
var cfnCustomDataIdentifierProps = new CfnCustomDataIdentifierProps {
Name = "name",
Regex = "regex",
// the properties below are optional
Description = "description",
IgnoreWords = new [] { "ignoreWords" },
Keywords = new [] { "keywords" },
MaximumMatchDistance = 123
};
Synopsis
Properties
Description | A custom description of the custom data identifier. The description can contain 1-512 characters. |
IgnoreWords | An array of character sequences ( ignore words ) to exclude from the results. |
Keywords | An array of character sequences ( keywords ), one of which must precede and be in proximity ( |
MaximumMatchDistance | The maximum number of characters that can exist between the end of at least one complete character sequence specified by the |
Name | A custom name for the custom data identifier. The name can contain 1-128 characters. |
Regex | The regular expression ( regex ) that defines the text pattern to match. |
Properties
Description
A custom description of the custom data identifier. The description can contain 1-512 characters.
virtual string Description { get; }
Property Value
System.String
Remarks
Avoid including sensitive data in the description. Users of the account might be able to see the description, depending on the actions that they're allowed to perform in Amazon Macie .
IgnoreWords
An array of character sequences ( ignore words ) to exclude from the results.
virtual string[] IgnoreWords { get; }
Property Value
System.String[]
Remarks
If text matches the regular expression ( Regex
) but it contains a string in this array, Amazon Macie ignores the text and doesn't include it in the results.
The array can contain 1-10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.
Keywords
An array of character sequences ( keywords ), one of which must precede and be in proximity ( MaximumMatchDistance
) of the regular expression ( Regex
) to match.
virtual string[] Keywords { get; }
Property Value
System.String[]
Remarks
The array can contain 1-50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.
MaximumMatchDistance
The maximum number of characters that can exist between the end of at least one complete character sequence specified by the Keywords
array and the end of text that matches the regular expression ( Regex
).
virtual Nullable<double> MaximumMatchDistance { get; }
Property Value
System.Nullable<System.Double>
Remarks
If a complete keyword precedes all the text that matches the regular expression and the keyword is within the specified distance, Amazon Macie includes the result.
The distance can be 1-300 characters. The default value is 50.
Name
A custom name for the custom data identifier. The name can contain 1-128 characters.
string Name { get; }
Property Value
System.String
Remarks
Avoid including sensitive data in the name of a custom data identifier. Users of the account might be able to see the name, depending on the actions that they're allowed to perform in Amazon Macie .
Regex
The regular expression ( regex ) that defines the text pattern to match.
string Regex { get; }
Property Value
System.String
Remarks
The expression can contain 1-512 characters.