custom_data_identifiers
Creates, updates, deletes or gets a custom_data_identifier
resource or lists custom_data_identifiers
in a region
Overview
Name | custom_data_identifiers |
Type | Resource |
Description | Macie CustomDataIdentifier resource schema |
Id | aws.macie.custom_data_identifiers |
Fields
Name | Datatype | Description |
---|---|---|
name | string | Name of custom data identifier. |
description | string | Description of custom data identifier. |
regex | string | Regular expression for custom data identifier. |
maximum_match_distance | integer | Maximum match distance. |
keywords | array | Keywords to be matched against. |
ignore_words | array | Words to be ignored. |
id | string | Custom data identifier ID. |
arn | string | Custom data identifier ARN. |
tags | array | A collection of tags associated with a resource |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
create_resource | INSERT | Name, Regex, region |
delete_resource | DELETE | data__Identifier, region |
update_resource | UPDATE | data__Identifier, data__PatchDocument, region |
list_resources | SELECT | region |
get_resource | SELECT | data__Identifier, region |
SELECT
examples
Gets all custom_data_identifiers
in a region.
SELECT
region,
name,
description,
regex,
maximum_match_distance,
keywords,
ignore_words,
id,
arn,
tags
FROM aws.macie.custom_data_identifiers
WHERE region = 'us-east-1';
Gets all properties from an individual custom_data_identifier
.
SELECT
region,
name,
description,
regex,
maximum_match_distance,
keywords,
ignore_words,
id,
arn,
tags
FROM aws.macie.custom_data_identifiers
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';
INSERT
example
Use the following StackQL query and manifest file to create a new custom_data_identifier
resource, using stack-deploy
.
- Required Properties
- All Properties
- Manifest
/*+ create */
INSERT INTO aws.macie.custom_data_identifiers (
Name,
Regex,
region
)
SELECT
'{{ Name }}',
'{{ Regex }}',
'{{ region }}';
/*+ create */
INSERT INTO aws.macie.custom_data_identifiers (
Name,
Description,
Regex,
MaximumMatchDistance,
Keywords,
IgnoreWords,
Tags,
region
)
SELECT
'{{ Name }}',
'{{ Description }}',
'{{ Regex }}',
'{{ MaximumMatchDistance }}',
'{{ Keywords }}',
'{{ IgnoreWords }}',
'{{ Tags }}',
'{{ region }}';
version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
value: '{{ vars.AWS_REGION }}'
resources:
- name: custom_data_identifier
props:
- name: Name
value: '{{ Name }}'
- name: Description
value: '{{ Description }}'
- name: Regex
value: '{{ Regex }}'
- name: MaximumMatchDistance
value: '{{ MaximumMatchDistance }}'
- name: Keywords
value:
- '{{ Keywords[0] }}'
- name: IgnoreWords
value:
- '{{ IgnoreWords[0] }}'
- name: Tags
value:
- Key: '{{ Key }}'
Value: '{{ Value }}'
DELETE
example
/*+ delete */
DELETE FROM aws.macie.custom_data_identifiers
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';
Permissions
To operate on the custom_data_identifiers
resource, the following permissions are required:
Create
macie2:CreateCustomDataIdentifier,
macie2:GetCustomDataIdentifier,
macie2:TagResource
Read
macie2:GetCustomDataIdentifier
Delete
macie2:DeleteCustomDataIdentifier
List
macie2:ListCustomDataIdentifiers
Update
macie2:TagResource,
macie2:UntagResource