software.amazon.awscdk.services.macie

Interface CfnCustomDataIdentifierProps

All Known Implementing Classes:

CfnCustomDataIdentifierProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-17T17:31:11.000Z")
public interface CfnCustomDataIdentifierProps

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 java.lang.String	getDescription() The description of the custom data identifier.
default java.util.List<java.lang.String>	getIgnoreWords() An array that lists specific character sequences (ignore words) to exclude from the results.
default java.util.List<java.lang.String>	getKeywords() An array that lists specific character sequences (keywords), one of which must be within proximity ( `MaximumMatchDistance` ) of the regular expression to match.
default java.lang.Number	getMaximumMatchDistance() The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the `Keywords` array.
java.lang.String	getName() A custom name for the custom data identifier.
java.lang.String	getRegex() The regular expression ( *regex* ) that defines the pattern to match.

Method Detail

getName

java.lang.String getName()

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 .

getRegex

java.lang.String getRegex()

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

The expression can contain as many as 512 characters.

getDescription

default java.lang.String getDescription()

The description of the custom data identifier.

The description can contain as many as 512 characters.

getIgnoreWords

default java.util.List<java.lang.String> getIgnoreWords()

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.

getKeywords

default java.util.List<java.lang.String> getKeywords()

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.

getMaximumMatchDistance

default java.lang.Number getMaximumMatchDistance()

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.

builder

static CfnCustomDataIdentifierProps.Builder builder()

Returns:

a CfnCustomDataIdentifierProps.Builder of CfnCustomDataIdentifierProps