# mc replicate update

LLMS index: [llms.txt](/llms.txt)

---

<a id="mc-replicate-update"></a>
<a id="minio-mc-replicate-update"></a>
<a id="minio-mc-replicate-edit"></a>

<a id="command-mc.replicate.edit"></a>

<a id="command-mc.replicate.update"></a>

> [!NOTE]
> **Changed: RELEASE.2022-12-24T15-21-38Z**
>
> `mc replicate update` replaces the `mc admin bucket remote update` command.

> [!NOTE]
> **Changed: RELEASE.2022-11-07T23-47-39Z**
>
> `mc replicate update` replaces the `mc replicate edit` command.

## Syntax {#syntax}

The [`mc replicate update`](#command-mc.replicate.update) command modifies an existing [bucket replication rule](/administration/bucket-replication/#minio-bucket-replication-serverside).

```shell
mc [GLOBALFLAGS] replicate update FLAGS [FLAGS] ARGUMENTS [ARGUMENTS]
```

**EXAMPLE**

The following command modifies an existing replication rule for the `mydata` bucket on the `myminio` MinIO deployment:

```shell
mc replicate update --id "c76um9h4b0t1ijr36mug"           \
   --replicate "delete,delete-marker,existing-objects"  \
   myminio/mydata
```

The new replication configuration synchronizes all versioned delete operations, delete marker creation, and existing objects to the remote MinIO deployment.

**SYNTAX**

The command has the following syntax:

```shell
mc [GLOBALFLAGS] replicate update              \
                 --remote-bucket string          \
                 [--bandwidth "string"]            \
                 [--healthcheck-seconds integer]   \
                 [--id "string"]                   \
                 [--limit-upload "string"]         \
                 [--limit-download "string"]       \
                 [--path "string"]                 \
                 [--priority int]                  \
                 [--proxy]
                 [--replicate "string"]            \
                 [--state string]
                 [--storage-class "string"]        \
                 [--sync string]                          \
                 [--tags "string"]                 \
                 ALIAS
```

- Brackets `[]` indicate optional parameters.
- Parameters sharing a line are mutually dependent.
- Parameters separated using the pipe `|` operator are mutually exclusive.

Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.

### Parameters {#parameters}

##### `ALIAS` {#mc.replicate.update.ALIAS}

*mc-cmd*

*Required*

The [alias](/reference/minio-mc/mc-alias-set/#alias) of the MinIO deployment and full path to the bucket or bucket prefix on which to modify the replication rule. For example:

```text
mc replicate update --id "c75nrap4b0talo3ipthg" [FLAGS]
```

##### `--id` {#mc.replicate.update.-id}

*mc-cmd*

*Required*

Specify the unique ID for a configured replication rule. Use the [`mc replicate ls`](/reference/minio-mc/mc-replicate-ls/#command-mc.replicate.ls) command to list the replication rules for a bucket.

##### `--bandwidth` {#mc.replicate.update.-bandwidth}

*mc-cmd*

*Optional*

Limit bandwidth rates to no more than the specified rate in KiB/s, MiB/s, or GiB/s. Valid units include:

- `B` for bytes
- `K` for kilobytes
- `G` for gigabytes
- `T` for terabytes
- `Ki` for kibibytes
- `Gi` for gibibytes
- `Ti` for tebibytes

For example, to limit bandwidth rates to no more than 1 GiB/s, use the following:

```text
--limit-upload 1Gi
```

If not specified, MinIO does not limit the bandwidth rate.

##### `--healthcheck-seconds` {#mc.replicate.update.-healthcheck-seconds}

*mc-cmd*

*Optional*

The length of time in seconds between checks on the health of the remote bucket.

If not specified, MinIO uses an interval of 60 seconds.

##### `--limit-download` {#mc.replicate.update.-limit-download}

*mc-cmd*

*Optional*

Limit download rates to no more than a specified rate in KiB/s, MiB/s, or GiB/s. Valid units include:

- `B` for bytes
- `K` for kilobytes
- `G` for gigabytes
- `T` for terabytes
- `Ki` for kibibytes
- `Gi` for gibibytes
- `Ti` for tebibytes

For example, to limit download rates to no more than 1 GiB/s, use the following:

```text
--limit-download 1G
```

If not specified, MinIO uses an unlimited download rate.

##### `--limit-upload` {#mc.replicate.update.-limit-upload}

*mc-cmd*

*Optional*

Limit upload rates to no more than the specified rate in KiB/s, MiB/s, or GiB/s. Valid units include:

- `B` for bytes
- `K` for kilobytes
- `G` for gigabytes
- `T` for terabytes
- `Ki` for kibibytes
- `Gi` for gibibytes
- `Ti` for tebibytes

For example, to limit upload rates to no more than 1 GiB/s, use the following:

```text
--limit-upload 1G
```

If not specified, MinIO uses an unlimited upload rate.

##### `--path` {#mc.replicate.update.-path}

*mc-cmd*

*Optional*

Enable path-style lookup support for the remote bucket.

Valid values include:

- `on` - use a path lookup to find the remote bucket
- `off` - use a resource locator style (such as a domain or IP address) lookup to find the remote bucket
- `auto` - ask MinIO to identify the correct type of lookup to use to find the remote bucket

When not defined, MinIO uses the `auto` value.

##### `--priority` {#mc.replicate.update.-priority}

*mc-cmd*

*Optional*

Specify the integer priority of the replication rule. The value *must* be unique among all other rules on the source bucket. Higher values imply a *higher* priority than all other rules.

##### `--proxy` {#mc.replicate.update.-proxy}

*mc-cmd*

*Optional*

When defining active-active replication between buckets, do not proxy.

Valid values include:

- `enable` - Enable proxying in active-active replication.
- `disable` - Disable proxying in active-active replication.

By default, MinIO defaults to `enable`.

##### `--remote-bucket` {#mc.replicate.update.-remote-bucket}

*mc-cmd*

*Optional*

Specify the credentials, destination deployment, and bucket of the remote location. Value may be an [alias](/reference/minio-mc/mc-alias-set/#alias) and bucket, location based (IP or URL), or path based.

For example, a URL based target might look like the following:

```text
--remote-bucket https://user:secret@myminio.cloudprovider.tld:9001/bucket
```

An alias based target might look like the following:

```text
--remote-bucket minio-target/my-bucket
```

##### `--replicate` {#mc.replicate.update.-replicate}

*mc-cmd*

*Optional*

Specify a comma-separated list of the following values to enable extended replication features:

- `delete` - Directs MinIO to replicate [DELETE operations](/administration/object-management/object-delete/#minio-object-delete) to the destination bucket.
- `delete-marker` - Directs MinIO to replicate delete markers to the destination bucket.
- `replica-metadata-sync` - Directs MinIO to synchronize metadata-only changes on a replicated object back to the source. This feature only effects [two-way active-active](/administration/bucket-replication/enable-server-side-two-way-bucket-replication/#minio-bucket-replication-serverside-twoway) replication configurations.

  Omitting this value directs MinIO to stop replicating metadata-only changes back to the source.
- `existing-objects` - Directs MinIO to replicate objects created prior to configuring or enabling replication. MinIO by default does *not* synchronize existing objects to the remote target.

  See [Replication of Existing Objects](/administration/bucket-replication/#minio-replication-behavior-existing-objects) for more information.

##### `--state` {#mc.replicate.update.-state}

*mc-cmd*

*Optional*

Enables or disables the replication rule. Specify one of the following values:

- `"enable"` - Enables the replication rule.
- `"disable"` - Disables the replication rule.

Objects created while replication is disabled are not immediately eligible for replication after enabling the rule. You must explicitly enable replication of existing objects by including `"existing-objects"` to the list of replication features specified to [`mc replicate update --replicate`](#mc.replicate.update.-replicate).

See [Replication of Existing Objects](/administration/bucket-replication/#minio-replication-behavior-existing-objects) for more information.

##### `--storage-class` {#mc.replicate.update.-storage-class}

*mc-cmd*

*Optional*

Specify the MinIO [storage class](/reference/minio-server/settings/storage-class/#minio-ec-storage-class) to apply to replicated objects.

##### `--sync` {#mc.replicate.update.-sync}

*mc-cmd*

*Optional*

Enable synchronous replication for this remote target.

By default, MinIO uses asynchronous replication.

##### `--tags` {#mc.replicate.update.-tags}

*mc-cmd*

*Optional*

Specify one or more ampersand `&` separated key-value pair tags which MinIO uses for filtering objects to replicate. For example:

```shell
mc replicate update --id "ID" --tags "TAG1=VALUE&TAG2=VALUE&TAG3=VALUE"
```

MinIO applies the replication rule to any object whose tag set contains the specified replication tags.

### Global Flags {#global-flags}

This command supports any of the [global flags](/reference/minio-mc/#minio-mc-global-options).

## Examples {#examples}

### Modify an Existing Replication Rule {#modify-an-existing-replication-rule}

Use [`mc replicate update`](#command-mc.replicate.update) to modify an existing replication rule.

```shell
mc replicate update ALIAS/PATH \
   --id ID                     \
   [--FLAGS]
```

- Replace [`ALIAS`](#mc.replicate.update.ALIAS) with the [`alias`](/reference/minio-mc/mc-alias/#command-mc.alias) of the MinIO deployment.
- Replace [`PATH`](#mc.replicate.update.ALIAS) with the path to the bucket or bucket prefix on which the rule exists.
- Replace [`ID`](#mc.replicate.update.-id) with the unique identifier for the rule to modify. Use [`mc replicate ls`](/reference/minio-mc/mc-replicate-ls/#command-mc.replicate.ls) to retrieve the list of replication rules on the bucket and their corresponding identifiers.

> [!NOTE]
> **Note**
>
> Modifying a replication configuration rule does not affect already replicated objects. For example, modifying the [`--tags`](#mc.replicate.update.-tags) filter does not result in the removal of replicated objects which do not meet the filter.

### Update the Credentials for an Existing Replication Rule {#update-the-credentials-for-an-existing-replication-rule}

Use [`mc replicate update`](#command-mc.replicate.update) to modify an existing replication rule.

```shell
mc replicate update ALIAS/PATH \
   --id ID                     \
   --remote-bucket https://user:secret@minio.mycloud.tld:9001/mybucket
```

- Replace [`ALIAS`](#mc.replicate.update.ALIAS) with the [`alias`](/reference/minio-mc/mc-alias/#command-mc.alias) of the MinIO deployment.
- Replace [`PATH`](#mc.replicate.update.ALIAS) with the path to the bucket or bucket prefix on which the rule exists.
- Replace [`ID`](#mc.replicate.update.-remote-bucket) with the updated credentials, path, and bucket.

### Disable or Enable an Existing Replication Rule {#disable-or-enable-an-existing-replication-rule}

Use [`mc replicate update`](#command-mc.replicate.update) with the [`--state`](#mc.replicate.update.-state) flag to disable or enable a replication rule.

```shell
mc replicate update ALIAS/PATH \
   --id ID \
   --state "disable"|"enable"
```

- Replace [`ALIAS`](#mc.replicate.update.ALIAS) with the [`alias`](/reference/minio-mc/mc-alias/#command-mc.alias) of the MinIO deployment.
- Replace [`PATH`](#mc.replicate.update.ALIAS) with the path to the bucket or bucket prefix on which the rule exists.
- Replace [`ID`](#mc.replicate.update.-id) with the unique identifier for the rule to modify. Use [`mc replicate ls`](/reference/minio-mc/mc-replicate-ls/#command-mc.replicate.ls) to retrieve the list of replication rules on the bucket and their corresponding identifiers.
- Specify either `"disable"` or `"enable"` to the [`--state`](#mc.replicate.update.-state) flag to disable or enable the replication rule.

> [!NOTE]
> **Note**
>
> MinIO requires enabling [existing object replication](/administration/bucket-replication/#minio-replication-behavior-existing-objects) to synchronize objects written or removed after disabling a replication rule.
>
> For rules *without* existing object replication, MinIO synchronizes only those write or delete operations issued while the replication rule is *enabled*.

## Behavior {#behavior}

### Required Permissions {#required-permissions}

MinIO strongly recommends creating users specifically for supporting bucket replication operations. See [`mc admin user`](/reference/minio-mc-admin/mc-admin-user/#command-mc.admin.user) and [`mc admin policy`](/reference/minio-mc-admin/mc-admin-policy/#command-mc.admin.policy) for more complete documentation on adding users and policies to a MinIO deployment.

**Replication Admin**

The following policy provides permissions for configuring and enabling replication on a deployment.

```json
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Action": [
                "admin:SetBucketTarget",
                "admin:GetBucketTarget",
                "admin:ListBatchJobs",
                "admin:DescribeBatchJob",
                "admin:StartBatchJob",
                "admin:CancelBatchJob"
            ],
            "Effect": "Allow",
            "Sid": "EnableRemoteBucketConfiguration"
        },
        {
            "Effect": "Allow",
            "Action": [
                "s3:GetReplicationConfiguration",
                "s3:ListBucket",
                "s3:ListBucketMultipartUploads",
                "s3:GetBucketLocation",
                "s3:GetBucketVersioning",
                "s3:GetObjectRetention",
                "s3:GetObjectLegalHold",
                "s3:PutReplicationConfiguration"
            ],
            "Resource": [
                "arn:aws:s3:::*"
            ],
            "Sid": "EnableReplicationRuleConfiguration"
        }
    ]
}

```

- The `"EnableRemoteBucketConfiguration"` statement grants permission for creating a remote target for supporting replication.
- The `"EnableReplicationRuleConfiguration"` statement grants permission for creating replication rules on a bucket. The `"arn:aws:s3:::*` resource applies the replication permissions to *any* bucket on the source deployment. You can restrict the user policy to specific buckets as-needed.

Use the [`mc admin policy create`](/reference/minio-mc-admin/mc-admin-policy-create/#command-mc.admin.policy.create) to add this policy to each deployment acting as a replication source. Use [`mc admin user add`](/reference/minio-mc-admin/mc-admin-user-add/#command-mc.admin.user.add) to create a user on the deployment and [`mc admin policy attach`](/reference/minio-mc-admin/mc-admin-policy-attach/#command-mc.admin.policy.attach) to associate the policy to that new user.

**Replication Remote User**

The following policy provides permissions for enabling synchronization of replicated data *into* the deployment.

```json
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "s3:GetReplicationConfiguration",
                "s3:ListBucket",
                "s3:ListBucketMultipartUploads",
                "s3:GetBucketLocation",
                "s3:GetBucketVersioning",
                "s3:GetBucketObjectLockConfiguration",
                "s3:GetEncryptionConfiguration"
            ],
            "Resource": [
                "arn:aws:s3:::*"
            ],
            "Sid": "EnableReplicationOnBucket"
        },
        {
            "Effect": "Allow",
            "Action": [
                "s3:GetReplicationConfiguration",
                "s3:ReplicateTags",
                "s3:AbortMultipartUpload",
                "s3:GetObject",
                "s3:GetObjectVersion",
                "s3:GetObjectVersionTagging",
                "s3:PutObject",
                "s3:PutObjectRetention",
                "s3:PutBucketObjectLockConfiguration",
                "s3:PutObjectLegalHold",
                "s3:DeleteObject",
                "s3:ReplicateObject",
                "s3:ReplicateDelete"
            ],
            "Resource": [
                "arn:aws:s3:::*"
            ],
            "Sid": "EnableReplicatingDataIntoBucket"
        }
    ]
}
```

- The `"EnableReplicationOnBucket"` statement grants permission for a remote target to retrieve bucket-level configuration for supporting replication operations on *all* buckets in the MinIO deployment. To restrict the policy to specific buckets, specify those buckets as an element in the `Resource` array similar to `"arn:aws:s3:::bucketName"`.
- The `"EnableReplicatingDataIntoBucket"` statement grants permission for a remote target to synchronize data into *any* bucket in the MinIO deployment. To restrict the policy to specific buckets, specify those buckets as an element in the `Resource` array similar to `"arn:aws:s3:::bucketName/*"`.

Use the [`mc admin policy create`](/reference/minio-mc-admin/mc-admin-policy-create/#command-mc.admin.policy.create) to add this policy to each deployment acting as a replication target. Use [`mc admin user add`](/reference/minio-mc-admin/mc-admin-user-add/#command-mc.admin.user.add) to create a user on the deployment and [`mc admin policy attach`](/reference/minio-mc-admin/mc-admin-policy-attach/#command-mc.admin.policy.attach) to associate the policy to that new user.

### S3 Compatibility {#s3-compatibility}

SILO is the supported server for PGSTY mcli; compatibility with upstream MinIO and other S3 services is [best effort](/reference/minio-mc/#command-mc).