AWS KMS
Ingests AWS Key Management Service (KMS) resources including encryption keys, aliases, and grants for security monitoring and compliance.
Sync Type: Full Synchronisation
Details
The AWS KMS input collects comprehensive information about your AWS KMS encryption keys and related resources. It provides insights into your encryption key management, usage patterns, and access controls to help you monitor and analyze your data encryption posture. Each input collects one resource type, chosen with KMS Type; to collect keys, aliases and grants, create three inputs.
KEYS: one record per key, holding theDescribeKeyresponse (the key's metadata underKeyMetadata, plus aResultMetadatafield).ALIASES: one record per alias, as returned byListAliases.GRANTS: one record per grant on every key in the region, as returned byListGrants.
Key policies and key rotation status are not collected. Each sync re-lists every resource of the selected type in the configured region, so the same resources are emitted again on every run. If the role cannot describe a key or list a key's grants (for example, because a key policy denies it), the sync stops with an error at that key, and records already sent in that sync are kept. Make sure the key policies of every key in the region allow the role to call the actions below.
Requirements
- AWS KMS must be configured in your AWS account with existing keys.
- IAM Role Assumption / Static Credentials
- Example permission to attach to the role/user:
Code
Configuration
Settings
| Setting | Type | Required | Default | Description |
|---|---|---|---|---|
region | string | Yes | us-east-1 | The AWS region to use. Allowed values: us-east-1, us-east-2, us-west-1, us-west-2, af-south-1, ap-east-1, ap-south-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-southeast-1, ap-southeast-2, ca-central-1, ca-west-1, cn-north-1, cn-northwest-1, eu-central-1, eu-west-1, eu-west-2, eu-west-3, eu-north-1, eu-south-1, me-south-1, sa-east-1, us-gov-east-1, us-gov-west-1. |
cron | string (cron) | Yes | 0 * * * * | Cron string for scheduling the ingest of your input. eg: 0 0 * * * - Daily at midnight, or */15 * * * * - Every 15 minutes. Defaults to an hour. |
role_arn | string | No | - | The ARN of the IAM role to assume for accessing AWS resources. |
kms_type | string | Yes | KEYS | Type of KMS resources to list Allowed values: KEYS, ALIASES, GRANTS. |
Secrets (Static Credentials Only)
| Secret | Type | Required | Description |
|---|---|---|---|
access_key | secret | No | The Access Key from AWS to authenticate with AWS |
secret_key | secret | No | The Secret Key from AWS to authenticate with AWS |
⚠️ Authentication: Choose either Role ARN (recommended) or static credentials. See AWS Authentication Guide for setup instructions.
Related Articles
Sync frequency
This input runs on a cron schedule (default hourly, 0 * * * *), which you can configure on the pipeline.
See Input Sync Frequency for details.
Community transforms
The Monad Transforms Repository has ready-made transforms for this input. Import one into your organization, then add it to a pipeline after this input.
| Format | Transform |
|---|---|
| OCSF v1.9.0 | AWS KMS Keys to OCSF v1.9.0 |
| ECS v9.5.0 | AWS KMS Keys to ECS v9.5.0 |
| CEF | AWS KMS Keys to CEF |
CEF transforms emit an intermediate record; add the CEF Serializer transform after one to produce the CEF:0 string.