Package software.amazon.awscdk.services.macie

Interface CfnAllowListProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAllowListProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:04.343Z")
@Stability(Stable)
public interface CfnAllowListProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.macie.*;
 CfnAllowListProps cfnAllowListProps = CfnAllowListProps.builder()
         .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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAllowListProps.Builder	A builder for CfnAllowListProps
static final class	CfnAllowListProps.Jsii$Proxy	An implementation for CfnAllowListProps

Method Summary

Modifier and Type	Method	Description
static CfnAllowListProps.Builder	builder()
Object	getCriteria()	The criteria that specify the text or text pattern to ignore.
default String	getDescription()	A custom description of the allow list.
String	getName()	A custom name for the allow list.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to the allow list.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCriteria

@Stability(Stable)
@NotNull
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.

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

A custom name for the allow list.

The name can contain 1-128 characters.

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A custom description of the allow list.

The description can contain 1-512 characters.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

For more information, see Resource tag .

See Also:

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

builder

@Stability(Stable)
static CfnAllowListProps.Builder builder()

Returns:

a CfnAllowListProps.Builder of CfnAllowListProps