---
title: "s3replicationpeer modify"
slug: "s3replicationpeer-modify"
tags: ["5.4"]
updated: 2026-10-28T01:52:52Z
published: 2026-10-28T01:52:52Z
canonical: "docs.vastdata.com/s3replicationpeer-modify"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vastdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# s3replicationpeer modify

This command modifies an S3 replication peer.

##### Usage

```plaintext
s3replicationpeer modify --id ID
                        [--access-key ACCESS_KEY]
                        [--secret-key SECRET_KEY]
                        [--bucket-name BUCKET_NAME]
                        [--http-protocol http|https]
                        [--custom-bucket-url CUSTOM_BUCKET_URL]
                        [--aws-region AWS_REGION]
                        [--name NAME]
                        [--proxies PROXIES]
```

##### Required Parameters

| `--id ID` | Specifies which S3 replication peer to modify, by its ID (integer). |
| --- | --- |

##### Options

| `--access-key ACCESS_KEY` | Specifies the access key of a key pair for accessing the bucket. |
| --- | --- |
| `--secret-key SECRET_KEY` | Specifies the access key of a key pair for accessing the bucket. |
| `--bucket-name BUCKET_NAME` | Sets the bucket name of the S3 bucket to which you are replicating the cluster's data (up to 63 characters). |
| `--http-protocol http\|https` | For custom S3 targets,.specifies which HTTP protocol over which to access the target. |
| `--custom-bucket-url CUSTOM_BUCKET_URL` | For a custom S3 target, specifies the URL of the custom bucket. |
| `--aws-region AWS_REGION` | For an AWS S3 target, specifies the AWS region where the bucket resides. *AWS-REGION* is the [region code](https://docs.aws.amazon.com/general/latest/gr/rande.html). |
| `--name NAME` | Sets the name of the target. |
| `--proxies PROXIES` | Specifies proxies. If proxies are specified, replication traffic is routed via the proxies to and from the replication target. Proxies can either be external to the cluster or they can run on a subset of the cluster's CNodes. To use a CNode as a proxy, first install third party proxy software on the CNode and then enter the proxy here. You can specify up to eight proxies. Traffic is load balanced between the specified proxies, excluding any inactive proxies if applicable. Specify each proxy using the format `http://<username>:<password>@<proxy IP>:<proxy port>`, in which `<username>` and `<password>` or the user name and password for authenticating to the proxy, `<proxy IP>` is the proxy's IP address and `<proxy port>` is the proxy port. To specify multiple proxies, separate the proxies by commas. For example: `--proxies http://admin:admin@192.0.2.0:8080,http://admin:admin@192.0.2.1:8080,http://admin:admin@192.0.2.2:8080` |

##### Example

This example changes the name of the S3 replication peer with ID 1 to "AWS-S3-REPLICATION-TARGET".

```plaintext
vcli: admin> s3replicationpeer modify --id 1 --name AWS-S3-REPLICATION-TARGET
```