CfnAllowListProps

class aws_cdk.aws_macie.CfnAllowListProps(*, criteria, name, description=None, tags=None)

Bases: object

Properties for defining a CfnAllowList.

Parameters:

criteria (Union[IResolvable, CriteriaProperty, Dict[str, Any]]) – 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 (str) – A custom name for the allow list. The name can contain 1-128 characters.
description (Optional[str]) – A custom description of the allow list. The description can contain 1-512 characters.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to the allow list. For more information, see Resource tag .

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_macie as macie

cfn_allow_list_props = macie.CfnAllowListProps(
    criteria=macie.CfnAllowList.CriteriaProperty(
        regex="regex",
        s3_words_list=macie.CfnAllowList.S3WordsListProperty(
            bucket_name="bucketName",
            object_key="objectKey"
        )
    ),
    name="name",

    # the properties below are optional
    description="description",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

criteria

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.

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

description

A custom description of the allow list.

The description can contain 1-512 characters.

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

name

A custom name for the allow list.

The name can contain 1-128 characters.

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

tags

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

For more information, see Resource tag .

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