Skip to main content
Sponsor @cloudposse

access-analyzer

This component is responsible for configuring AWS Identity and Access Management Access Analyzer within an AWS Organization.

IAM Access Analyzer helps you identify the resources in your organization and accounts, such as Amazon S3 buckets or IAM roles, shared with an external entity. This lets you identify unintended access to your resources and data, which is a security risk. IAM Access Analyzer identifies resources shared with external principals by using logic-based reasoning to analyze the resource-based policies in your AWS environment. For each instance of a resource shared outside of your account, IAM Access Analyzer generates a finding. Findings include information about the access and the external principal granted to it. You can review findings to determine if the access is intended and safe or if the access is unintended and a security risk. In addition to helping you identify resources shared with an external entity, you can use IAM Access Analyzer findings to preview how your policy affects public and cross-account access to your resource before deploying resource permissions. The findings are organized in a visual summary dashboard. The dashboard highlights the split between public and cross-account access findings, and provides a breakdown of findings by resource type.

IAM Access Analyzer analyzes only policies applied to resources in the same AWS Region where it's enabled. To monitor all resources in your AWS environment, you must create an analyzer to enable IAM Access Analyzer in each Region where you're using supported AWS resources.

AWS Identity and Access Management Access Analyzer provides the following capabilities:

  • IAM Access Analyzer external access analyzers help identify resources in your organization and accounts that are shared with an external entity.

  • IAM Access Analyzer unused access analyzers help identify unused access in your organization and accounts.

  • IAM Access Analyzer validates IAM policies against policy grammar and AWS best practices.

  • IAM Access Analyzer custom policy checks help validate IAM policies against your specified security standards.

  • IAM Access Analyzer generates IAM policies based on access activity in your AWS CloudTrail logs.

Here's a typical workflow:

Delegate Access Analyzer to another account: From the Organization management (root) account, delegate administration to a specific AWS account within your organization (usually the security account).

Create Access Analyzers in the Delegated Administrator Account: Enable the Access Analyzers for external access and unused access in the delegated administrator account.

Deployment Overview​

components:
  terraform:
    access-analyzer/defaults:
      metadata:
        component: access-analyzer
        type: abstract
      vars:
        enabled: true
        global_environment: gbl
        account_map_tenant: core
        root_account_stage: root
        delegated_administrator_account_name: core-mgt
        accessanalyzer_service_principal: "access-analyzer.amazonaws.com"
        accessanalyzer_organization_enabled: false
        accessanalyzer_organization_unused_access_enabled: false
        organizations_delegated_administrator_enabled: false
import:
  - catalog/access-analyzer/defaults

components:
  terraform:
    access-analyzer/root:
      metadata:
        component: access-analyzer
        inherits:
          - access-analyzer/defaults
      vars:
        organizations_delegated_administrator_enabled: true
import:
  - catalog/access-analyzer/defaults

components:
  terraform:
    access-analyzer/delegated-administrator:
      metadata:
        component: access-analyzer
        inherits:
          - access-analyzer/defaults
      vars:
        accessanalyzer_organization_enabled: true
        accessanalyzer_organization_unused_access_enabled: true
        unused_access_age: 30

Provisioning​

Delegate Access Analyzer to the security account:

atmos terraform apply access-analyzer/root -s plat-dev-gbl-root

Provision Access Analyzers for external access and unused access in the delegated administrator (security) account in each region:

atmos terraform apply access-analyzer/delegated-administrator -s plat-dev-use1-mgt

Variables​

Required Variables​

accessanalyzer_organization_enabled (bool) required

Flag to enable the Organization Access Analyzer

accessanalyzer_organization_unused_access_enabled (bool) required

Flag to enable the Organization unused access Access Analyzer

account_map_tenant (string) required

The tenant where the account_map component required by remote-state is deployed

delegated_administrator_account_name (string) required

The name of the account that is the AWS Organization Delegated Administrator account

organizations_delegated_administrator_enabled (bool) required

Flag to enable the Organization delegated administrator

region (string) required

AWS Region

Optional Variables​

accessanalyzer_service_principal (string) optional

The Access Analyzer service principal for which you want to make the member account a delegated administrator


Default value: "access-analyzer.amazonaws.com"

global_environment (string) optional

Global environment name


Default value: "gbl"

organization_management_account_name (string) optional

The name of the AWS Organization management account


Default value: null

root_account_stage (string) optional

The stage name for the Organization root (management) account. This is used to lookup account IDs from account names
using the account-map component.



Default value: "root"

unused_access_age (number) optional

The specified access age in days for which to generate findings for unused access


Default value: 30

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​

aws_organizations_delegated_administrator_id

AWS Organizations Delegated Administrator ID

aws_organizations_delegated_administrator_status

AWS Organizations Delegated Administrator status

organization_accessanalyzer_id

Organization Access Analyzer ID

organization_unused_access_accessanalyzer_id

Organization unused access Access Analyzer ID

Dependencies​

Requirements​

  • terraform, version: >= 1.3.0
  • aws, version: >= 4.9.0

Providers​

  • aws, version: >= 4.9.0

Modules​

NameVersionSourceDescription
account_map1.5.0cloudposse/stack-config/yaml//modules/remote-staten/a
iam_roleslatest../account-map/modules/iam-rolesn/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:

References​