Amazon Web Services S3

The basic on-premises installation uses the local file system for data storage. This is sufficient for a single server installation, as well as for a multi-server installation where you can share a file system between server nodes. Alternatively, Amazon Web Services S3 can be used for data storage. Please note this requires the high-availability add-on.




Configuration

The basic steps to configure S3 are:

  1. Create a bucket under your AWS account (folders named workspaces and reviews will be created in this bucket).
  2. Create a new programmatic access user in AWS, with the following permissions: AmazonS3FullAccess.
  3. Modify your structurizr.properties file to configure AWS S3 integration as follows:
Property name Property value
structurizr.data aws-s3
aws-s3.accessKeyId Your AWS API key ID.
aws-s3.secretAccessKey Your AWS API secret access key.
aws-s3.region Your AWS region (e.g. us-east-1).
aws-s3.bucketName Your S3 bucket name.

Alternatively, you can leave the aws-s3.accessKeyId and aws-s3.secretAccessKey parameters unset, and the on-premises installation will use the "Default Credential Provider Chain" to search your environment for the credentials, as described at Working with AWS Credentials - Using the Default Credential Provider Chain.