Skip to main content
Sponsor @cloudposse

Module: macie

Terraform module to provision Amazon Macie - a fully managed data security and data privacy service that uses machine learning and pattern matching to discover and protect your sensitive data in AWS

Usage​

  provider "aws" {
    assume_role {
      role_arn = "arn:aws:iam::11111111111:role/my-org-root"
    }
  }
  provider "aws" {
    alias  = "macie_admin" # delegated admin
    assume_role {
      role_arn = "arn:aws:iam::22222222222:role/my-org-security"
    }
  }
  module "macie" {
    source = "cloudposse/macie/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version     = "x.x.x"
    providers = {
      aws.admin = aws
      aws       = aws.macie_admin
    }
  }

Examples​

Here is an example of using this module:

Variables​

Required Variables​

Optional Variables​

account_status (bool) optional

Macie account status. Possible values are ENABLED and PAUSED. Setting it to ENABLED will start all Macie activities for the account.


Default value: true

admin_account_ids (list(string)) optional

The list of AWS account IDs for the account to designate as the delegated Amazon Macie administrator accounts for the organization.


Default value: [ ]

classification_jobs (list(any)) optional

A list of maps of classification jobs.
name:
A custom name for the job.
description:
A custom description of the job.
tags:
A map of key-value pairs that specifies the tags to associate with the job.
sampling_percentage:
The sampling depth, as a percentage, to apply when processing objects.
This value determines the percentage of eligible objects that the job analyzes.
initial_run:
Whether to analyze all existing, eligible objects immediately after the job is created.
job_type:
The schedule for running the job.
If you specify SCHEDULED value, use the schedule_frequency property to define the recurrence pattern for the job.
Possible values: ONE_TIME, SCHEDULED.
job_status:
The status for the job.
Possible values: CANCELLED, RUNNING and USER_PAUSED.


schedule_frequency:
daily_schedule:
Specifies a daily recurrence pattern for running the job.
weekly_schedule:
Specifies a weekly recurrence pattern for running the job.
monthly_schedule:
Specifies a monthly recurrence pattern for running the job.




Default value: [ ]

custom_data_identifiers (list(any)) optional

A list of maps of custom data identifiers.
A custom data identifier is a set of criteria that you defined to detect sensitive data in one or more data sources.
regex:
The regular expression (regex) that defines the pattern to match.
The expression can contain as many as 512 characters.
keywords:
An array that lists specific character sequences (keywords), one of which must be within proximity (maximum_match_distance) of the regular expression to match.
The array can contain as many as 50 keywords.
Each keyword can contain 3 - 90 characters. Keywords aren't case sensitive.
ignore_words:
An array that lists specific character sequences (ignore words) to exclude from the results.
If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it.
The array can contain as many as 10 ignore words.
Each ignore word can contain 4 - 90 characters.
maximum_match_distance:
The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array.
Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern.
The distance can be 1 - 300 characters. The default value is 50.
name:
A custom name for the custom data identifier.
description:
A custom description of the custom data identifier.
tags:
A map of key-value pairs that specifies the tags to associate with the custom data identifier.



Default value: [ ]

finding_publishing_frequency (string) optional

Specifies how often to publish updates to policy findings for the account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events). Valid values are FIFTEEN_MINUTES, ONE_HOUR or SIX_HOURS.


Default value: "ONE_HOUR"

members (list(any)) optional

A list of maps of Amazon Macie Members.
account_id:
The AWS account ID for the account.
email:
The email address for the account.
tags:
A map of key-value pairs that specifies the tags to associate with the account in Amazon Macie.
status:
Specifies the status for the account.
Possible values: ENABLED, PAUSED.
invite:
Whether to send an invitation to a member.
invitation_message:
A custom message to include in the invitation.
Amazon Macie adds this message to the standard content that it sends for an invitation.
invitation_disable_email_notification:
Whether to send an email notification to the root user of each account that the invitation will be sent to.



Default value: [ ]

Context Variables​

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.


Required: No

Default value: { }

attributes (list(string)) optional

ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.


Required: No

Default value: [ ]

context (any) optional

Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.


Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}
delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.


Required: No

Default value: null

descriptor_formats (any) optional

Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).


Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.


Required: No

Default value: null

label_key_case (string) optional

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.


Required: No

Default value: null

label_order (list(string)) optional

The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.


Required: No

Default value: null

label_value_case (string) optional

Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.


Required: No

Default value: null

labels_as_tags (set(string)) optional

Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.


Required: No

Default value:

[
  "default"
]
name (string) optional

ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.


Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.


Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.


Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs​

account_id

The ID of the Macie account.

account_service_role_arn

The service role ARN of the Macie account.

aws_account_to_org_admin_account_ids

Map of the AWS account IDs to Macie organization admin account IDs

member_accounts

List of AWS account IDs the Macie Admin is managing

org_admin_account_ids

List of IDs of the Macie organization admin accounts.

Dependencies​

Requirements​

  • terraform, version: >= 0.15.0
  • aws, version: >= 3.38

Providers​

  • aws, version: >= 3.38
  • aws, version: >= 3.38

Modules​

NameVersionSourceDescription
classification_job_label0.25.0cloudposse/label/nulln/a
custom_data_identifier_label0.25.0cloudposse/label/nulln/a
member_label0.25.0cloudposse/label/nulln/a
this0.25.0cloudposse/label/nulln/a

Resources​

The following resources are used by this module:

Data Sources​

The following data sources are used by this module: