# AWS S3 Rehydration

### Object Format

Rehydrated data must be in [OTLP format JSON](https://github.com/open-telemetry/opentelemetry-proto) for correct processing. Ensure your data adheres to this format.

The [AWS S3 Destination](https://docs.bindplane.com/integrations/destinations/aws-s3) supports `gzip` compression. This receiver will gracefully detect and handle if any data is gzipped or uncompressed.

### Supported Platforms

| Platform             | Supported |
| -------------------- | --------- |
| Linux                | ✓         |
| Windows              | ✓         |
| macOS                | ✓         |
| Kubernetes Cluster\* | ✓         |

Available in the Bindplane Distro for OpenTelemetry Collector `v1.69.0+`.

\* **Note:** When deploying with a Kubernetes Cluster agent, select `StatefulSet` as the deployment method.

### Configuration Fields

<table><thead><tr><th width="188.41796875">Field</th><th>Description</th></tr></thead><tbody><tr><td>Region</td><td>The AWS recognized region string</td></tr><tr><td>Bucket</td><td>Name of the S3 Bucket to rehydration telemetry from.</td></tr><tr><td>Folder Prefix</td><td>Root directory of the bucket to rehydration telemetry from.</td></tr><tr><td>Poll Size</td><td>The max number of object descriptions to be returned by a single poll against the S3 API.</td></tr><tr><td>Batch Size</td><td>The max number of object descriptions to process &#x26; rehydrate at once after retrieving from the S3 API.</td></tr><tr><td>Starting Time</td><td>UTC start time for rehydration in the format <code>YYYY-MM-DDTHH:MM</code>.</td></tr><tr><td>Ending Time</td><td>UTC end time for rehydration in the format <code>YYYY-MM-DDTHH:MM</code>.</td></tr><tr><td>Delete on Read</td><td>If true, objects are deleted after rehydration.</td></tr><tr><td>Enable Storage</td><td>Enable to specify a storage extension for tracking rehydration progress.</td></tr><tr><td>Storage Directory</td><td>Directory for storing rehydration state, useful for maintaining state and resuming operations. (Only relevant if <code>Enable Storage</code> is true)</td></tr></tbody></table>

### Usage

#### Kubernetes

When deploying on Kubernetes, you must configuration authentication to AWS. This can be done by\
setting the following environment.

Edit the YAML manifest downloaded from Bindplane's agent install page. Add the following environment variables to the `opentelemetry-container` container.

```yaml
spec:
  template:
    spec:
      containers:
        - name: opentelemetry-container
          env:
            - name: AWS_ACCESS_KEY_ID
              value: '<your access key>'
            - name: AWS_SECRET_ACCESS_KEY
              value: '<your secret key>'
```

### Example Configuration

#### Basic Configuration

This configuration sets up AWS S3 Rehydration with necessary details such as Region, Bucket, and time range for rehydration.

<figure><img src="https://1405008107-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmiOMzBfoNFwmKJFHMcJ%2Fuploads%2Fgit-blob-284d754f5c6c17582da19c1267e6ee4a35e3233a%2Fintegrations-sources-aws-s3-rehydration-readme-image-1.png?alt=media" alt="Bindplane docs - AWS S3 Rehydration - image 1"><figcaption></figcaption></figure>

Adjust the Region, Bucket, Starting Time, and Ending Time to match your configuration.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.bindplane.com/integrations/sources/aws-s3-rehydration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.