Skip to main content

S3

Experimental
Creates:
Assets

Configure in the UI

This plugin can be configured directly in the Marmot UI with a step-by-step wizard.

View Guide

The S3 plugin discovers and catalogs Amazon S3 buckets across your AWS accounts. It captures bucket metadata including security configurations, lifecycle policies, encryption settings, and tags.

Required Permissions

Example Configuration


credentials:
region: "us-east-1"
id: "<aws-secret-id>"
secret: "<aws-secret-key>"
tags:
- "s3"

Configuration

The following configuration options are available:

PropertyTypeRequiredDescription
credentialsAWSCredentialsfalseAWS credentials configuration
external_links[]ExternalLinkfalseExternal links to show on all assets
filterFilterfalseFilter patterns for AWS resources
include_tags[]stringfalseList of AWS tags to include as metadata. By default, all tags are included.
tagsTagsConfigfalseTags to apply to discovered assets
tags_to_metadataboolfalseConvert AWS tags to Marmot metadata

Available Metadata

The following metadata fields are available:

FieldTypeDescription
accelerate_configstringTransfer acceleration configuration
bucket_arnstringThe ARN of the S3 bucket
creation_datestringWhen the bucket was created
encryptionstringBucket encryption configuration
lifecycle_configstringBucket lifecycle configuration
logging_configstringBucket access logging configuration
notification_configstringBucket notification configuration
public_access_blockstringPublic access block configuration
regionstringThe AWS region where the bucket is located
replication_configstringBucket replication configuration
request_payment_configstringRequest payment configuration
tagsmap[string]stringAWS resource tags
versioningstringBucket versioning status
website_configstringStatic website hosting configuration