Package software.amazon.awscdk.services.macie

Class CfnCustomDataIdentifier

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.macie.CfnCustomDataIdentifier
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:59.847Z") @Stability(Stable) public class CfnCustomDataIdentifier extends CfnResource implements IInspectable
A CloudFormation AWS::Macie::CustomDataIdentifier.

The AWS::Macie::CustomDataIdentifier resource specifies a custom data identifier. A custom data identifier is a set of custom criteria for Amazon Macie to use when it inspects data sources for sensitive data. The criteria consist of a regular expression ( regex ) that defines a text pattern to match and, optionally, character sequences and a proximity rule that refine the results. The character sequences can be:

  • Keywords , which are words or phrases that must be in proximity of text that matches the regex, or
  • Ignore words , which are words or phrases to exclude from the results.

By using custom data identifiers, you can supplement the managed data identifiers that Macie provides and detect sensitive data that reflects your particular scenarios, intellectual property, or proprietary data. For more information, see Building custom data identifiers in the Amazon Macie User Guide .

An AWS::Macie::Session resource must exist for an AWS account before you can create an AWS::Macie::CustomDataIdentifier resource for the account. Use a DependsOn attribute to ensure that an AWS::Macie::Session resource is created before other Macie resources are created for an account. For example, "DependsOn": "Session" .

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.*;
 CfnCustomDataIdentifier cfnCustomDataIdentifier = CfnCustomDataIdentifier.Builder.create(this, "MyCfnCustomDataIdentifier")
         .name("name")
         .regex("regex")
         // the properties below are optional
         .description("description")
         .ignoreWords(List.of("ignoreWords"))
         .keywords(List.of("keywords"))
         .maximumMatchDistance(123)
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCustomDataIdentifier

      protected CfnCustomDataIdentifier(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCustomDataIdentifier

      protected CfnCustomDataIdentifier(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCustomDataIdentifier

      @Stability(Stable) public CfnCustomDataIdentifier(@NotNull Construct scope, @NotNull String id, @NotNull CfnCustomDataIdentifierProps props)
      Create a new AWS::Macie::CustomDataIdentifier.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the custom data identifier.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The unique identifier for the custom data identifier.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getName

      @Stability(Stable) @NotNull public String getName()
      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 .

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      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 .

    • getRegex

      @Stability(Stable) @NotNull public String getRegex()
      The regular expression ( regex ) that defines the text pattern to match.

      The expression can contain 1-512 characters.

    • setRegex

      @Stability(Stable) public void setRegex(@NotNull String value)
      The regular expression ( regex ) that defines the text pattern to match.

      The expression can contain 1-512 characters.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      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 .

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      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 .

    • getIgnoreWords

      @Stability(Stable) @Nullable public List<String> getIgnoreWords()
      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.

    • setIgnoreWords

      @Stability(Stable) public void setIgnoreWords(@Nullable List<String> value)
      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.

    • getKeywords

      @Stability(Stable) @Nullable public List<String> getKeywords()
      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.

    • setKeywords

      @Stability(Stable) public void setKeywords(@Nullable List<String> value)
      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.

    • getMaximumMatchDistance

      @Stability(Stable) @Nullable public Number getMaximumMatchDistance()
      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.

    • setMaximumMatchDistance

      @Stability(Stable) public void setMaximumMatchDistance(@Nullable Number value)
      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.