software.amazon.awscdk.services.macie

Class CfnCustomDataIdentifier.Builder

java.lang.Object

software.amazon.awscdk.services.macie.CfnCustomDataIdentifier.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCustomDataIdentifier>

Enclosing class:

CfnCustomDataIdentifier

@Stability(value=Stable)
public static final class CfnCustomDataIdentifier.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCustomDataIdentifier>

A fluent builder for CfnCustomDataIdentifier.

Method Summary

Modifier and Type	Method and Description
CfnCustomDataIdentifier	build()
static CfnCustomDataIdentifier.Builder	create(software.constructs.Construct scope, String id)
CfnCustomDataIdentifier.Builder	description(String description) The description of the custom data identifier.
CfnCustomDataIdentifier.Builder	ignoreWords(List<String> ignoreWords) An array that lists specific character sequences (ignore words) to exclude from the results.
CfnCustomDataIdentifier.Builder	keywords(List<String> keywords) An array that lists specific character sequences (keywords), one of which must be within proximity ( `MaximumMatchDistance` ) of the regular expression to match.
CfnCustomDataIdentifier.Builder	maximumMatchDistance(Number maximumMatchDistance) The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the `Keywords` array.
CfnCustomDataIdentifier.Builder	name(String name) A custom name for the custom data identifier.
CfnCustomDataIdentifier.Builder	regex(String regex) The regular expression ( *regex* ) that defines the pattern to match.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnCustomDataIdentifier.Builder create(software.constructs.Construct scope,
                                                                              String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnCustomDataIdentifier.Builder.

name

@Stability(value=Stable)
public CfnCustomDataIdentifier.Builder name(String 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 .

Parameters:

name - A custom name for the custom data identifier. The name can contain as many as 128 characters. This parameter is required.

Returns:

this

regex

@Stability(value=Stable)
public CfnCustomDataIdentifier.Builder regex(String regex)

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

The expression can contain as many as 512 characters.

Parameters:

regex - The regular expression ( *regex* ) that defines the pattern to match. This parameter is required.

Returns:

this

description

@Stability(value=Stable)
public CfnCustomDataIdentifier.Builder description(String description)

The description of the custom data identifier.

The description can contain as many as 512 characters.

Parameters:

description - The description of the custom data identifier. This parameter is required.

Returns:

this

ignoreWords

@Stability(value=Stable)
public CfnCustomDataIdentifier.Builder ignoreWords(List<String> ignoreWords)

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.

Parameters:

ignoreWords - An array that lists specific character sequences (ignore words) to exclude from the results. This parameter is required.

Returns:

this

keywords

@Stability(value=Stable)
public CfnCustomDataIdentifier.Builder keywords(List<String> 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.

Parameters:

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

Returns:

this

maximumMatchDistance

@Stability(value=Stable)
public CfnCustomDataIdentifier.Builder maximumMatchDistance(Number maximumMatchDistance)

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.

Parameters:

maximumMatchDistance - The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the `Keywords` array. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnCustomDataIdentifier build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnCustomDataIdentifier>