Package software.amazon.awscdk.cfnpropertymixins.services.macie

Class CfnCustomDataIdentifierPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.macie.CfnCustomDataIdentifierPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:20:01.248Z") @Stability(Stable) public class CfnCustomDataIdentifierPropsMixin extends Mixin implements software.constructs.IMixin
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.cfnpropertymixins.services.macie.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnCustomDataIdentifierPropsMixin cfnCustomDataIdentifierPropsMixin = CfnCustomDataIdentifierPropsMixin.Builder.create(CfnCustomDataIdentifierMixinProps.builder()
         .description("description")
         .ignoreWords(List.of("ignoreWords"))
         .keywords(List.of("keywords"))
         .maximumMatchDistance(123)
         .name("name")
         .regex("regex")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnCustomDataIdentifierPropsMixin

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

    • CfnCustomDataIdentifierPropsMixin

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

    • CfnCustomDataIdentifierPropsMixin

      @Stability(Stable) public CfnCustomDataIdentifierPropsMixin(@NotNull CfnCustomDataIdentifierMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::Macie::CustomDataIdentifier.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnCustomDataIdentifierPropsMixin

      @Stability(Stable) public CfnCustomDataIdentifierPropsMixin(@NotNull CfnCustomDataIdentifierMixinProps props)
      Create a mixin to apply properties to AWS::Macie::CustomDataIdentifier.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnCustomDataIdentifierMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()