Package 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(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	Description
CfnCustomDataIdentifier	build()
static CfnCustomDataIdentifier.Builder	create(software.constructs.Construct scope, String id)
CfnCustomDataIdentifier.Builder	description(String description)	A custom description of the custom data identifier.
CfnCustomDataIdentifier.Builder	ignoreWords(List<String> ignoreWords)	An array of character sequences ( ignore words ) to exclude from the results.
CfnCustomDataIdentifier.Builder	keywords(List<String> keywords)	An array of character sequences ( keywords ), one of which must precede and be in proximity ( MaximumMatchDistance ) of the regular expression ( Regex ) to match.
CfnCustomDataIdentifier.Builder	maximumMatchDistance(Number 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 ).
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 text pattern to match.
CfnCustomDataIdentifier.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to the custom data identifier.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(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 - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnCustomDataIdentifier.Builder.

name

@Stability(Stable)
public CfnCustomDataIdentifier.Builder name(String name)

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 .

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-name

regex

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

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

The expression can contain 1-512 characters.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-regex

description

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

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 .

Parameters:

description - A custom description of the custom data identifier. The description can contain 1-512 characters. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-description

ignoreWords

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

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.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-ignorewords

keywords

@Stability(Stable)
public CfnCustomDataIdentifier.Builder keywords(List<String> keywords)

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.

Parameters:

keywords - An array of character sequences ( keywords ), one of which must precede and be in proximity ( MaximumMatchDistance ) of the regular expression ( Regex ) to match. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-keywords

maximumMatchDistance

@Stability(Stable)
public CfnCustomDataIdentifier.Builder maximumMatchDistance(Number 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 ).

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.

Parameters:

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 ). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-maximummatchdistance

tags

@Stability(Stable)
public CfnCustomDataIdentifier.Builder tags(List<? extends CfnTag> tags)

An array of key-value pairs to apply to the custom data identifier.

For more information, see Resource tag .

Parameters:

tags - An array of key-value pairs to apply to the custom data identifier. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-tags

build

@Stability(Stable)
public CfnCustomDataIdentifier build()

Specified by:

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

Returns:

a newly built instance of CfnCustomDataIdentifier.