Package software.amazon.awscdk.services.macie

Class CfnAllowList

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.CfnAllowList
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.844Z") @Stability(Stable) public class CfnAllowList extends CfnResource implements IInspectable
A CloudFormation AWS::Macie::AllowList.

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.services.macie.*;
 CfnAllowList cfnAllowList = CfnAllowList.Builder.create(this, "MyCfnAllowList")
         .criteria(CriteriaProperty.builder()
                 .regex("regex")
                 .s3WordsList(S3WordsListProperty.builder()
                         .bucketName("bucketName")
                         .objectKey("objectKey")
                         .build())
                 .build())
         .name("name")
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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

    • CfnAllowList

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

    • CfnAllowList

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

    • CfnAllowList

      @Stability(Stable) public CfnAllowList(@NotNull Construct scope, @NotNull String id, @NotNull CfnAllowListProps props)
      Create a new AWS::Macie::AllowList.

      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 allow list.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The unique identifier for the allow list.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The current status of the allow list, which indicates whether Amazon Macie can access and use the list's criteria.

      If the list's criteria specify a regular expression ( Regex ), this value is typically OK . Macie can compile the expression. If the list's criteria specify an Amazon S3 object ( S3WordsList ), possible values are:

      • OK - Macie can retrieve and parse the contents of the object.
      • S3_OBJECT_ACCESS_DENIED - Macie isn't allowed to access the object or the object is encrypted with a customer managed AWS KMS key that Macie isn't allowed to use. Check the bucket policy and other permissions settings for the bucket and the object. If the object is encrypted, also ensure that it's encrypted with a key that Macie is allowed to use.
      • S3_OBJECT_EMPTY - Macie can retrieve the object but the object doesn't contain any content. Ensure that the object contains the correct entries. Also ensure that the list's criteria specify the correct bucket and object names.
      • S3_OBJECT_NOT_FOUND - The object doesn't exist in Amazon S3 . Ensure that the list's criteria specify the correct bucket and object names.
      • S3_OBJECT_OVERSIZE - Macie can retrieve the object. However, the object contains too many entries or its storage size exceeds the quota for an allow list. Try breaking the list into multiple files and ensure that each file doesn't exceed any quotas. Then configure list settings in Macie for each file.
      • S3_THROTTLED - Amazon S3 throttled the request to retrieve the object. Wait a few minutes and then try again.
      • S3_USER_ACCESS_DENIED - Amazon S3 denied the request to retrieve the object. If the specified object exists, you're not allowed to access it or it's encrypted with an AWS KMS key that you're not allowed to use. Work with your AWS administrator to ensure that the list's criteria specify the correct bucket and object names, and you have read access to the bucket and the object. If the object is encrypted, also ensure that it's encrypted with a key that you're allowed to use.
      • UNKNOWN_ERROR - A transient or internal error occurred when Macie attempted to retrieve or parse the object. Wait a few minutes and then try again. A list can also have this status if it's encrypted with a key that Amazon S3 and Macie can't access or use.

      For more information, see Allow list options and requirements in the Amazon Macie User Guide .

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to the allow list.

      For more information, see Tag .

    • getCriteria

      @Stability(Stable) @NotNull public Object getCriteria()
      The criteria that specify the text or text pattern to ignore.

      The criteria can be the location and name of an Amazon S3 object that lists specific text to ignore ( S3WordsList ), or a regular expression ( Regex ) that defines a text pattern to ignore.

    • setCriteria

      @Stability(Stable) public void setCriteria(@NotNull CfnAllowList.CriteriaProperty value)
      The criteria that specify the text or text pattern to ignore.

      The criteria can be the location and name of an Amazon S3 object that lists specific text to ignore ( S3WordsList ), or a regular expression ( Regex ) that defines a text pattern to ignore.

    • setCriteria

      @Stability(Stable) public void setCriteria(@NotNull IResolvable value)
      The criteria that specify the text or text pattern to ignore.

      The criteria can be the location and name of an Amazon S3 object that lists specific text to ignore ( S3WordsList ), or a regular expression ( Regex ) that defines a text pattern to ignore.

    • getName

      @Stability(Stable) @NotNull public String getName()
      A custom name for the allow list.

      The name can contain 1-128 characters.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A custom name for the allow list.

      The name can contain 1-128 characters.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A custom description of the allow list.

      The description can contain 1-512 characters.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A custom description of the allow list.

      The description can contain 1-512 characters.