Creates a replication configuration or replaces an existing one. For more information,
see Replication in the Amazon S3 User Guide.
Specify the replication configuration in the request body. In the replication
configuration, you provide the name of the destination bucket or buckets where you want
Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your
behalf, and other relevant information. You can invoke this request for a specific
Amazon Web Services Region by using the
aws:RequestedRegion condition key.
A replication configuration must include at least one rule, and can contain a maximum of
1,000. Each rule identifies a subset of objects to replicate by filtering the objects in
the source bucket. To choose additional subsets of objects to replicate, add a rule for
each subset.
To specify a subset of the objects in the source bucket to apply a replication rule to,
add the Filter element as a child of the Rule element. You can filter objects based on an
object key prefix, one or more object tags, or both. When you add the Filter element in the
configuration, you must also add the following elements:
DeleteMarkerReplication, Status, and
Priority.
If you are using an earlier version of the replication configuration, Amazon S3 handles
replication of delete markers differently. For more information, see Backward Compatibility.
For information about enabling versioning on a bucket, see Using Versioning.
Handling Replication of Encrypted Objects
By default, Amazon S3 doesn't replicate objects that are stored at rest using
server-side encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects,
add the following: SourceSelectionCriteria,
SseKmsEncryptedObjects, Status,
EncryptionConfiguration, and ReplicaKmsKeyID. For
information about replication configuration, see Replicating
Objects Created with SSE Using KMS keys.
Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 User Guide.
Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket or buckets where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information. You can invoke this request for a specific Amazon Web Services Region by using the
aws:RequestedRegion
condition key.A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset.
To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements:
DeleteMarkerReplication
,Status
, andPriority
.If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility.
For information about enabling versioning on a bucket, see Using Versioning.
By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following:
SourceSelectionCriteria
,SseKmsEncryptedObjects
,Status
,EncryptionConfiguration
, andReplicaKmsKeyID
. For information about replication configuration, see Replicating Objects Created with SSE Using KMS keys.For information on
PutBucketReplication
errors, see List of replication-related error codesTo create a
PutBucketReplication
request, you must haves3:PutReplicationConfiguration
permissions for the bucket.Example
Use a bare-bones client and the command you need to make an API call.
Param
PutBucketReplicationCommandInput
Returns
PutBucketReplicationCommandOutput
See
input
shape.response
shape.config
shape.Throws
S3ServiceException
Base exception class for all service exceptions from S3 service.
Example
Set replication configuration on a bucket