Class CfnCustomDataIdentifierProps

Properties for defining a CfnCustomDataIdentifier.

Inheritance

System.Object

CfnCustomDataIdentifierProps

Implements

ICfnCustomDataIdentifierProps

Namespace: Amazon.CDK.AWS.Macie

Assembly: Amazon.CDK.AWS.Macie.dll

Syntax (csharp)

public class CfnCustomDataIdentifierProps : Object, ICfnCustomDataIdentifierProps

Syntax (vb)

Public Class CfnCustomDataIdentifierProps
    Inherits Object
    Implements ICfnCustomDataIdentifierProps

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Macie;

var cfnCustomDataIdentifierProps = new CfnCustomDataIdentifierProps {
    Name = "name",
    Regex = "regex",

    // the properties below are optional
    Description = "description",
    IgnoreWords = new [] { "ignoreWords" },
    Keywords = new [] { "keywords" },
    MaximumMatchDistance = 123
};

Synopsis

Constructors

CfnCustomDataIdentifierProps()

Properties

Description	A custom description of the custom data identifier. The description can contain 1-512 characters.
IgnoreWords	An array of character sequences ( ignore words ) to exclude from the results.
Keywords	An array of character sequences ( keywords ), one of which must precede and be in proximity ( `MaximumMatchDistance` ) of the regular expression ( `Regex` ) to match.
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` ).
Name	A custom name for the custom data identifier. The name can contain 1-128 characters.
Regex	The regular expression ( regex ) that defines the text pattern to match.

Constructors

CfnCustomDataIdentifierProps()

public CfnCustomDataIdentifierProps()

Properties

Description

A custom description of the custom data identifier. The description can contain 1-512 characters.

public string Description { get; set; }

Property Value

System.String

Remarks

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 .

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

IgnoreWords

An array of character sequences ( ignore words ) to exclude from the results.

public string[] IgnoreWords { get; set; }

Property Value

System.String[]

Remarks

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.

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

Keywords

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

public string[] Keywords { get; set; }

Property Value

System.String[]

Remarks

The array can contain 1-50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.

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

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

public Nullable<double> MaximumMatchDistance { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

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.

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

Name

A custom name for the custom data identifier. The name can contain 1-128 characters.

public string Name { get; set; }

Property Value

System.String

Remarks

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 .

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

Regex

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

public string Regex { get; set; }

Property Value

System.String

Remarks

The expression can contain 1-512 characters.

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

Implements

ICfnCustomDataIdentifierProps