Configure a snapshot repository using AWS S3
ECE
To store Elasticsearch snapshots in AWS S3, you need to configure a snapshot repository in Elastic Cloud Enterprise (ECE). This guide explains how to add an Amazon S3 repository using the Cloud UI and provides details on required settings and advanced configurations.
To add a snapshot repository:
From the Platform menu, select Repositories.
Select Add Repository to add an existing repository.
Provide a name for the repository configuration.
ECE Snapshot Repository names are now required to meet the same standards as S3 buckets. Refer to the official AWS documentation on Bucket naming rules.
Select one of the supported repository types and specify the necessary settings:
Amazon S3 configuration:
All repository options must be specified, as there are no default values.
- Region
- The region where the bucket is located.
- Bucket
- The name of the bucket to be used for snapshots.
- Access key
- The access key to use for authentication.
- Secret key
-
The secret key to use for authentication.
Advanced configuration:
Used for Microsoft Azure, Google Cloud Platform, or for some Amazon S3 repositories where you need to provide additional configuration parameters not supported by the S3 repository option. Configurations must be specified in a valid JSON format. For example:
Amazon S3 (check supported settings):
{ "type": "s3", "settings": { "bucket": "my_bucket_name", "region": "us-west" } }
NoteDon’t set
base_path
when configuring a snapshot repository for Elastic Cloud Enterprise. Elastic Cloud Enterprise automatically generates thebase_path
for each deployment so that multiple deployments may share the same bucket.
Select Save.