custom_data_identifiers

Creates, updates, deletes, gets or lists a custom_data_identifiers resource.

Overview

Name	custom_data_identifiers
Type	Resource
Id	aws.macie2.custom_data_identifiers

Fields

The following fields are returned by SELECT queries:

get_custom_data_identifier

Name	Datatype	Description
id	string	The unique identifier for the custom data identifier.
name	string	The custom name of the custom data identifier.
arn	string	The Amazon Resource Name (ARN) of the custom data identifier.
created_at	string (date-time)	The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.
deleted	boolean	Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft deletes the identifier.
description	string	The custom description of the custom data identifier.
ignore_words	array	An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. Ignore words are case sensitive.
keywords	array	An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. Keywords aren't case sensitive.
maximum_match_distance	integer	The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. Otherwise, Macie excludes the result.
regex	string	The regular expression (regex) that defines the pattern to match.
severity_levels	array	The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that matches the custom data identifier's detection criteria. You can specify as many as three SeverityLevel objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the occurrences thresholds must be in ascending order by severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and 100 for HIGH. If an S3 object contains fewer occurrences than the lowest specified threshold, Amazon Macie doesn't create a finding. If you don't specify any values for this array, Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie automatically assigns the MEDIUM severity to those findings.
tags	object	A map of key-value pairs that identifies the tags (keys and values) that are associated with the custom data identifier.

list_custom_data_identifiers

Name	Datatype	Description
id	string	The unique identifier for the custom data identifier.
name	string	The custom name of the custom data identifier.
arn	string	The Amazon Resource Name (ARN) of the custom data identifier.
created_at	string (date-time)	The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.
description	string	The custom description of the custom data identifier.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_custom_data_identifier	select	id, region		Retrieves the criteria and other settings for a custom data identifier.
list_custom_data_identifiers	select	region		Retrieves a subset of information about the custom data identifiers for an account.
create_custom_data_identifier	insert	region, name, regex		Creates and defines the criteria and other settings for a custom data identifier.
delete_custom_data_identifier	delete	id, region		Soft deletes a custom data identifier.
batch_get_custom_data_identifiers	exec	region		Retrieves information about one or more custom data identifiers.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The unique identifier for the Amazon Macie resource that the request applies to.
region	string	AWS region (default: us-east-1)

SELECT examples

get_custom_data_identifier

Retrieves the criteria and other settings for a custom data identifier.

SELECT
id,
name,
arn,
created_at,
deleted,
description,
ignore_words,
keywords,
maximum_match_distance,
regex,
severity_levels,
tags
FROM aws.macie2.custom_data_identifiers
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_custom_data_identifiers

Retrieves a subset of information about the custom data identifiers for an account.

SELECT
id,
name,
arn,
created_at,
description
FROM aws.macie2.custom_data_identifiers
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_custom_data_identifier

Creates and defines the criteria and other settings for a custom data identifier.

INSERT INTO aws.macie2.custom_data_identifiers (
clientToken,
description,
ignoreWords,
keywords,
maximumMatchDistance,
name,
regex,
severityLevels,
tags,
region
)
SELECT 
'{{ clientToken }}',
'{{ description }}',
'{{ ignoreWords }}',
'{{ keywords }}',
{{ maximumMatchDistance }},
'{{ name }}' /* required */,
'{{ regex }}' /* required */,
'{{ severityLevels }}',
'{{ tags }}',
'{{ region }}'
RETURNING
custom_data_identifier_id
;

Manifest

# Description fields are for documentation purposes
- name: custom_data_identifiers
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the custom_data_identifiers resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: description
    value: "{{ description }}"
  - name: ignoreWords
    value:
      - "{{ ignoreWords }}"
  - name: keywords
    value:
      - "{{ keywords }}"
  - name: maximumMatchDistance
    value: {{ maximumMatchDistance }}
  - name: name
    value: "{{ name }}"
  - name: regex
    value: "{{ regex }}"
  - name: severityLevels
    description: |
      The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that matches the custom data identifier's detection criteria. You can specify as many as three SeverityLevel objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the occurrences thresholds must be in ascending order by severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and 100 for HIGH. If an S3 object contains fewer occurrences than the lowest specified threshold, Amazon Macie doesn't create a finding. If you don't specify any values for this array, Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie automatically assigns the MEDIUM severity to those findings.
    value:
      - occurrencesThreshold: {{ occurrencesThreshold }}
        severity: "{{ severity }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      A string-to-string map of key-value pairs that specifies the tags (keys and values) for an Amazon Macie resource.

DELETE examples

delete_custom_data_identifier

Soft deletes a custom data identifier.

DELETE FROM aws.macie2.custom_data_identifiers
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

batch_get_custom_data_identifiers

Retrieves information about one or more custom data identifiers.

EXEC aws.macie2.custom_data_identifiers.batch_get_custom_data_identifiers 
@region='{{ region }}' --required 
@@json=
'{
"ids": "{{ ids }}"
}'
;