PUT service replication

Description

Sets replication configuration for the specified bucket.

Requests

Syntax

PUT /?replication HTTP/1.1
Host: <bucket>.<host>
Date: <date>
Authorization: <authorization_string>

Parameters

PUT service replication parameters

Parameter Description Required
bucket

Bucket name.

Type: string.

Default value: none.

Yes
user_id

ID of the user that is used to replicate objects on your behalf.

Type: string.

Default: none.

Yes
destination_bucket

The name of the bucket where you want to store the results.

Type: string.

Default: none.

Yes

Body

An XML replication configuration in the following format:

<?xml version="1.0" encoding="UTF-8"?>
<ReplicationConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
   <Role>arn:aws:iam::<user_id>:role/s3-replication-role</Role>
   <Rule>
      <Status>Enabled|Disabled</Status>
      <Priority>1</Priority>
      <DeleteMarkerReplication>
         <Status>Enabled|Disabled</Status>
      </DeleteMarkerReplication>
      <Filter>
         <Prefix />
      </Filter>
      <Destination>
         <Bucket>arn:aws:s3:::<destination_bucket></Bucket>
      </Destination>
   </Rule>
</ReplicationConfiguration>

Headers

Header Description
x-amz-geo-endpoint

Endpoint of the remote region where to replicate objects to.

x-amz-geo-access-key Access key of a user of the remote region used to replicate objects.
x-amz-geo-access-secret Access secret of a user of the remote region used to replicate objects.

Responses

Headers

This implementation uses only common response headers.

Body

Empty.

Examples

Sample request

Sets replication configuration for the bucket. test.

PUT/?replication HTTP/1.1
Host: test.s3.example.com
Date: Tu, 18 Jan 2021 14:08:55 GMT
Authorization: <authorization_string>
<ReplicationConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
   <Role>arn:aws:iam::850b4943d62191a5:role/s3-replication-role</Role>
   <Rule>
      <Status>Enabled</Status>
      <Priority>1</Priority>
      <DeleteMarkerReplication>
         <Status>Disabled</Status>
      </DeleteMarkerReplication>
      <Filter>
         <Prefix />
      </Filter>
      <Destination>
         <Bucket>arn:aws:s3:::AWSDOC-EXAMPLE-BUCKET2</Bucket>
      </Destination>
   </Rule>
</ReplicationConfiguration>

Sample response

HTTP/1.1 200 OK
Transfer-encoding : chunked
Server : nginx/1.8.1
Connection: closed
x-amz-request-id : 80000000000000030005c8caec96d65b
Date : Tu, 21 Jan 2021 14:08:56 GMT