---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "opensearch_snapshot_repository Resource - terraform-provider-opensearch"
subcategory: ""
description: |-
  Provides an Opensearch snapshot repository resource.
---

# opensearch_snapshot_repository (Resource)

Provides an Opensearch snapshot repository resource.

## Example Usage

```terraform
# Create a snapshot repository
resource "opensearch_snapshot_repository" "repo" {
  name = "es-index-backups"
  type = "s3"
  settings = {
    bucket   = "es-index-backups"
    region   = "us-east-1"
    role_arn = "arn:aws:iam::123456789012:role/MyRole"
  }
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `name` (String) The name of the repository.
- `type` (String) The name of the repository backend (required plugins must be installed).

### Optional

- `settings` (Map of String) The settings map applicable for the backend, see official documentation for plugins.

### Read-Only

- `id` (String) The ID of this resource.

## Import

Import is supported using the following syntax:

```shell
terraform import opensearch_snapshot_repository.repo es-index-backups
```