Interface CfnCustomDataIdentifierProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnCustomDataIdentifierProps.Jsii$Proxy
CfnCustomDataIdentifier
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.macie.*; CfnCustomDataIdentifierProps cfnCustomDataIdentifierProps = CfnCustomDataIdentifierProps.builder() .name("name") .regex("regex") // the properties below are optional .description("description") .ignoreWords(List.of("ignoreWords")) .keywords(List.of("keywords")) .maximumMatchDistance(123) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnCustomDataIdentifierProps
static final class
An implementation forCfnCustomDataIdentifierProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
A custom description of the custom data identifier.An array of character sequences ( ignore words ) to exclude from the results.An array of character sequences ( keywords ), one of which must precede and be in proximity (MaximumMatchDistance
) of the regular expression (Regex
) to match.default Number
The maximum number of characters that can exist between the end of at least one complete character sequence specified by theKeywords
array and the end of text that matches the regular expression (Regex
).getName()
A custom name for the custom data identifier.getRegex()
The regular expression ( regex ) that defines the text pattern to match.getTags()
An array of key-value pairs to apply to the custom data identifier.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getName
A custom name for the custom data identifier. The name can contain 1-128 characters.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 .
- See Also:
-
getRegex
The regular expression ( regex ) that defines the text pattern to match.The expression can contain 1-512 characters.
- See Also:
-
getDescription
A custom description of the custom data identifier. The description can contain 1-512 characters.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 .
- See Also:
-
getIgnoreWords
An array of character sequences ( ignore words ) to exclude from the results.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.
- See Also:
-
getKeywords
An array of character sequences ( keywords ), one of which must precede and be in proximity (MaximumMatchDistance
) of the regular expression (Regex
) to match.The array can contain 1-50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.
- See Also:
-
getMaximumMatchDistance
The maximum number of characters that can exist between the end of at least one complete character sequence specified by theKeywords
array and the end of text that matches the regular expression (Regex
).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.
- See Also:
-
getTags
An array of key-value pairs to apply to the custom data identifier.For more information, see Resource tag .
- See Also:
-
builder
-