interface CfnCustomDataIdentifierProps

Language	Type name
.NET	`Amazon.CDK.AWS.Macie.CfnCustomDataIdentifierProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsmacie#CfnCustomDataIdentifierProps`
Java	`software.amazon.awscdk.services.macie.CfnCustomDataIdentifierProps`
Python	`aws_cdk.aws_macie.CfnCustomDataIdentifierProps`
TypeScript	`aws-cdk-lib` » `aws_macie` » `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 { aws_macie as macie } from 'aws-cdk-lib';
const cfnCustomDataIdentifierProps: macie.CfnCustomDataIdentifierProps = {
  name: 'name',
  regex: 'regex',

  // the properties below are optional
  description: 'description',
  ignoreWords: ['ignoreWords'],
  keywords: ['keywords'],
  maximumMatchDistance: 123,
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
name	`string`	A custom name for the custom data identifier. The name can contain 1-128 characters.
regex	`string`	The regular expression ( regex ) that defines the text pattern to match.
description?	`string`	A custom description of the custom data identifier. The description can contain 1-512 characters.
ignoreWords?	`string[]`	An array of character sequences ( ignore words ) to exclude from the results.
keywords?	`string[]`	An array of character sequences ( keywords ), one of which must precede and be in proximity ( `MaximumMatchDistance` ) of the regular expression ( `Regex` ) to match.
maximumMatchDistance?	`number`	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` ).
tags?	`CfnTag[]`	An array of key-value pairs to apply to the custom data identifier.

name

Type: string

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 .

regex

Type: string

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

The expression can contain 1-512 characters.

description?

Type: string (optional)

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 .

ignoreWords?

Type: string[] (optional)

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.

keywords?

Type: string[] (optional)

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.

maximumMatchDistance?

Type: number (optional)

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.

tags?

Type: CfnTag[] (optional)

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

For more information, see Resource tag .