software.amazon.awscdk.services.macie

Interface CfnCustomDataIdentifierProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCustomDataIdentifierProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:36.939Z")
 @Stability(value=Stable)
public interface CfnCustomDataIdentifierProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `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)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnCustomDataIdentifierProps.Builder A builder for CfnCustomDataIdentifierProps
static class	CfnCustomDataIdentifierProps.Jsii$Proxy An implementation for CfnCustomDataIdentifierProps

Method Summary

Modifier and Type	Method and Description
static CfnCustomDataIdentifierProps.Builder	builder()
default String	getDescription() A custom description of the custom data identifier.
default List<String>	getIgnoreWords() An array of character sequences ( *ignore words* ) to exclude from the results.
default List<String>	getKeywords() 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	getMaximumMatchDistance() 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` ).
String	getName() A custom name for the custom data identifier.
String	getRegex() The regular expression ( *regex* ) that defines the text pattern to match.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

@Stability(value=Stable)
 @NotNull
String 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 .

getRegex

@Stability(value=Stable)
 @NotNull
String getRegex()

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

The expression can contain 1-512 characters.

getDescription

@Stability(value=Stable)
 @Nullable
default String 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 .

getIgnoreWords

@Stability(value=Stable)
 @Nullable
default List<String> 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.

getKeywords

@Stability(value=Stable)
 @Nullable
default List<String> 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.

getMaximumMatchDistance

@Stability(value=Stable)
 @Nullable
default Number getMaximumMatchDistance()

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` ).

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.

builder

@Stability(value=Stable)
static CfnCustomDataIdentifierProps.Builder builder()

Returns:

a CfnCustomDataIdentifierProps.Builder of CfnCustomDataIdentifierProps