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

Class CfnAllowListPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.macie.CfnAllowListPropsMixin

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.245Z")
@Stability(Stable)
public class CfnAllowListPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::Macie::AllowList resource specifies an allow list.

In Amazon Macie , an allow list defines specific text or a text pattern for Macie to ignore when it inspects data sources for sensitive data. If data matches text or a text pattern in an allow list, Macie doesn’t report the data in sensitive data findings or sensitive data discovery results, even if the data matches the criteria of a custom data identifier or a managed data identifier. You can create and use allow lists in all the AWS Regions where Macie is currently available except the Asia Pacific (Osaka) Region.

Macie supports two types of allow lists:

• Predefined text - For this type of list ( S3WordsList ), you create a line-delimited plaintext file that lists specific text to ignore, and you store the file in an Amazon Simple Storage Service ( Amazon S3 ) bucket. You then configure settings for Macie to access the list in the bucket.

This type of list typically contains specific words, phrases, and other kinds of character sequences that aren’t sensitive, aren't likely to change, and don’t necessarily adhere to a common pattern. If you use this type of list, Macie doesn't report occurrences of text that exactly match a complete entry in the list. Macie treats each entry in the list as a string literal value. Matches aren't case sensitive.

• Regular expression - For this type of list ( Regex ), you specify a regular expression that defines a text pattern to ignore. Unlike an allow list with predefined text, you store the regex and all other list settings in Macie .

This type of list is helpful if you want to specify text that isn’t sensitive but varies or is likely to change while also adhering to a common pattern. If you use this type of list, Macie doesn't report occurrences of text that completely match the pattern defined by the list.

For more information, see Defining sensitive data exceptions with allow lists in the Amazon Macie User Guide .

An AWS::Macie::Session resource must exist for an AWS account before you can create an AWS::Macie::AllowList 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;
 CfnAllowListPropsMixin cfnAllowListPropsMixin = CfnAllowListPropsMixin.Builder.create(CfnAllowListMixinProps.builder()
         .criteria(CriteriaProperty.builder()
                 .regex("regex")
                 .s3WordsList(S3WordsListProperty.builder()
                         .bucketName("bucketName")
                         .objectKey("objectKey")
                         .build())
                 .build())
         .description("description")
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-allowlist.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnAllowListPropsMixin.Builder	A fluent builder for CfnAllowListPropsMixin.
static interface	CfnAllowListPropsMixin.CriteriaProperty	Specifies the criteria for an allow list, which is a list that defines specific text or a text pattern to ignore when inspecting data sources for sensitive data.
static interface	CfnAllowListPropsMixin.S3WordsListProperty	Specifies the location and name of an Amazon Simple Storage Service ( Amazon S3 ) object that lists specific, predefined text to ignore when inspecting data sources for sensitive data.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnAllowListPropsMixin(CfnAllowListMixinProps props)	Create a mixin to apply properties to AWS::Macie::AllowList.
	CfnAllowListPropsMixin(CfnAllowListMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Macie::AllowList.
protected	CfnAllowListPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAllowListPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnAllowListMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

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

Constructor Details

CfnAllowListPropsMixin

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

CfnAllowListPropsMixin

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

CfnAllowListPropsMixin

@Stability(Stable)
public CfnAllowListPropsMixin(@NotNull
 CfnAllowListMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Macie::AllowList.

Parameters:

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

options - Mixin options.

CfnAllowListPropsMixin

@Stability(Stable)
public CfnAllowListPropsMixin(@NotNull
 CfnAllowListMixinProps props)

Create a mixin to apply properties to AWS::Macie::AllowList.

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 CfnAllowListMixinProps getProps()

getStrategy

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