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:

• examples/complete - complete example of using this module

Requirements

Name	Version
terraform	>= 0.15.0
aws	>= 3.38

Providers

Name	Version
aws	>= 3.38
aws.admin	>= 3.38

Modules

Name	Source	Version
classification_job_label	cloudposse/label/null	0.25.0
custom_data_identifier_label	cloudposse/label/null	0.25.0
member_label	cloudposse/label/null	0.25.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_macie2_account.default	resource
aws_macie2_classification_job.default	resource
aws_macie2_custom_data_identifier.default	resource
aws_macie2_member.default	resource
aws_macie2_organization_admin_account.default	resource

Inputs

Name	Description	Type	Default	Required
account_status	Macie account status. Possible values are ENABLED and PAUSED. Setting it to ENABLED will start all Macie activities for the account.	bool	true	no
additional_tag_map	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.	map(string)	{}	no
admin_account_ids	The list of AWS account IDs for the account to designate as the delegated Amazon Macie administrator accounts for the organization.	list(string)	[]	no
attributes	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.	list(string)	[]	no
classification_jobs	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.	list(any)	[]	no
context	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.	any	{ "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 }	no
custom_data_identifiers	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.	list(any)	[]	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
descriptor_formats	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).	any	{}	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
finding_publishing_frequency	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.	string	"ONE_HOUR"	no
id_length_limit	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.	number	null	no
label_key_case	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.	string	null	no
label_order	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.	list(string)	null	no
label_value_case	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.	string	null	no
labels_as_tags	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.	set(string)	[ "default" ]	no
members	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.	list(any)	[]	no
name	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.	string	null	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	string	null	no
regex_replace_chars	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.	string	null	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no

Outputs

Name	Description
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.