interface CfnAllowListProps

Language	Type name
.NET	`Amazon.CDK.AWS.Macie.CfnAllowListProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsmacie#CfnAllowListProps`
Java	`software.amazon.awscdk.services.macie.CfnAllowListProps`
Python	`aws_cdk.aws_macie.CfnAllowListProps`
TypeScript	`aws-cdk-lib` » `aws_macie` » `CfnAllowListProps`

Properties for defining a CfnAllowList.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_macie as macie } from 'aws-cdk-lib';
const cfnAllowListProps: macie.CfnAllowListProps = {
  criteria: {
    regex: 'regex',
    s3WordsList: {
      bucketName: 'bucketName',
      objectKey: 'objectKey',
    },
  },
  name: 'name',

  // the properties below are optional
  description: 'description',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
criteria	`IResolvable` `\|` `CriteriaProperty`	The criteria that specify the text or text pattern to ignore.
name	`string`	A custom name for the allow list.
description?	`string`	A custom description of the allow list.
tags?	`CfnTag[]`	An array of key-value pairs to apply to the allow list.

criteria

Type: IResolvable | CriteriaProperty

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.

name

Type: string

A custom name for the allow list.

The name can contain 1-128 characters.

description?

Type: string (optional)

A custom description of the allow list.

The description can contain 1-512 characters.

tags?

Type: CfnTag[] (optional)

An array of key-value pairs to apply to the allow list.

For more information, see Resource tag .