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

> ## 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 create

This command adds a cloud destination for replication. The destination must be an AWS S3 bucket or a custom destination that supports S3 access.

##### Usage - AWS S3 Bucket

```plaintext
s3replicationpeer create --name NAME
                         --bucket-name BUCKET_NAME
                         --type AWS_S3
                         --access-key ACCESS_KEY
                         --secret-key SECRET_KEY
                         --aws-region AWS_REGION
                         [--proxies PROXIES]
```

##### Usage - Custom S3 Bucket

```plaintext
s3replicationpeer create --name NAME
                         --bucket-name BUCKET_NAME
                         --http-protocol http|https
                         --type CUSTOM_S3
                         --access-key ACCESS_KEY
                         --secret-key SECRET_KEY
                         --custom-bucket-url CUSTOM_BUCKET_URL
                         [--proxies PROXIES]
```

##### Required Parameters

| `--name NAME` | Sets the name of the target. |
| --- | --- |
| `--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` | Required only if type is set to custom_s3. Specifies which HTTP protocol over which to access the target. |
| `--type AWS_S3\|CUSTOM_S3` | Specify whether the target is an AWS bucket (`AWS_S3`) or a custom S3 destination (`Custom_S3`). |
| `--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. |

##### Options

| `--custom-bucket-url CUSTOM_BUCKET_URL` | For a custom S3 target, include this option and specify the URL of the custom bucket. |
| --- | --- |
| `--aws-region AWS_REGION` | For an AWS S3 target, include this option to specify the AWS region where the bucket resides. *AWS-REGION* is the [region code](https://docs.aws.amazon.com/general/latest/gr/rande.html). |
| `--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

```plaintext
vcli: admin> s3replicationpeer create --name MY-S3-BACKUP-TARGET --type AWS_S3 --access-key AKIARTN2ZMSYQSD5CW45 --secret-key ON/mupAUNe4DdWR5/thZxfoY2xjLLzLCb0SHqQ8n --bucket-name my-s3-bucket --aws-region us-east-1
```