class CfnAllowListPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Macie.Mixins.CfnAllowListPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsmacie/mixins#CfnAllowListPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.macie.mixins.CfnAllowListPropsMixin
Python	aws_cdk.mixins_preview.aws_macie.mixins.CfnAllowListPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_macie » mixins » CfnAllowListPropsMixin

Implements IMixin

Extends Mixin

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

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as macie_mixins } from '@aws-cdk/mixins-preview/aws-macie';
const cfnAllowListPropsMixin = new macie_mixins.CfnAllowListPropsMixin({
  criteria: {
    regex: 'regex',
    s3WordsList: {
      bucketName: 'bucketName',
      objectKey: 'objectKey',
    },
  },
  description: 'description',
  name: 'name',
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnAllowListPropsMixin(props: CfnAllowListMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnAllowListMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

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

Properties

Name	Type	Description
props	CfnAllowListMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnAllowListMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.