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	awscc.macie.custom_data_identifiers

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
id	string	Custom data identifier ID.
region	string	AWS region.

For more information, see AWS::Macie::CustomDataIdentifier.

Methods

Name	Resource	Accessible by	Required Params
create_resource	custom_data_identifiers	INSERT	Name, Regex, region
delete_resource	custom_data_identifiers	DELETE	Identifier, region
update_resource	custom_data_identifiers	UPDATE	Identifier, PatchDocument, region
list_resources	custom_data_identifiers_list_only	SELECT	region
get_resource	custom_data_identifiers	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual custom_data_identifier.

SELECT
  region,
  name,
  description,
  regex,
  maximum_match_distance,
  keywords,
  ignore_words,
  id,
  arn,
  tags
FROM awscc.macie.custom_data_identifiers
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all custom_data_identifiers in a region.

SELECT
  region,
  id
FROM awscc.macie.custom_data_identifiers_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new custom_data_identifier resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.macie.custom_data_identifiers (
  Name,
  Regex,
  region
)
SELECT
  '{{ name }}',
  '{{ regex }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.macie.custom_data_identifiers (
  Name,
  Description,
  Regex,
  MaximumMatchDistance,
  Keywords,
  IgnoreWords,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ regex }}',
  '{{ maximum_match_distance }}',
  '{{ keywords }}',
  '{{ ignore_words }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

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: maximum_match_distance
      value: '{{ maximum_match_distance }}'
    - name: keywords
      value:
        - '{{ keywords[0] }}'
    - name: ignore_words
      value:
        - '{{ ignore_words[0] }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a custom_data_identifier resource, using stack-deploy.

/*+ update */
UPDATE awscc.macie.custom_data_identifiers
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.macie.custom_data_identifiers
WHERE
  Identifier = '{{ id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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,
macie2:GetCustomDataIdentifier