Skip to content

Create Allow List

macie2_create_allow_list R Documentation

Creates and defines the settings for an allow list

Description

Creates and defines the settings for an allow list.

Usage

macie2_create_allow_list(clientToken, criteria, description, name, tags)

Arguments

clientToken

[required] A unique, case-sensitive token that you provide to ensure the idempotency of the request.

criteria

[required] The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression (regex) that defines a text pattern to ignore.

description

A custom description of the allow list. The description can contain as many as 512 characters.

name

[required] A custom name for the allow list. The name can contain as many as 128 characters.

tags

A map of key-value pairs that specifies the tags to associate with the allow list.

An allow list can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Value

A list with the following syntax:

list(
  arn = "string",
  id = "string"
)

Request syntax

svc$create_allow_list(
  clientToken = "string",
  criteria = list(
    regex = "string",
    s3WordsList = list(
      bucketName = "string",
      objectKey = "string"
    )
  ),
  description = "string",
  name = "string",
  tags = list(
    "string"
  )
)