Table of Contents

Class PutBucketReplicationRequest

Namespace
Amazon.S3.Model
Assembly
AWSSDK.S3.dll

Container for the parameters to the PutBucketReplication operation. 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.

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
.
note

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 CMKs stored in Amazon Web Services KMS. 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 CMKs stored in Amazon Web Services KMS.

For information on 

PutBucketReplication
errors, see List of replication-related error codes

Permissions

To create a 

PutBucketReplication
request, you must have 
s3:PutReplicationConfiguration
permissions for the bucket.

By default, a resource owner, in this case the Amazon Web Services account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your Amazon S3 Resources.

note

To perform this operation, the user or role performing the action must have the iam:PassRole permission.

The following operations are related to 

PutBucketReplication
: 
public class PutBucketReplicationRequest : AmazonWebServiceRequest
Inheritance
PutBucketReplicationRequest

Constructors

PutBucketReplicationRequest() 

public PutBucketReplicationRequest()

Properties

BucketName

Gets and sets the property BucketName.

The name of the bucket 

public string BucketName { get; set; }

Property Value

string

ChecksumAlgorithm

Gets and sets the property ChecksumAlgorithm.

Indicates the algorithm used to create the checksum for the object. Amazon S3 will fail the request with a 400 error if there is no checksum associated with the object. For more information, see Checking object integrity in the Amazon S3 User Guide. 

public ChecksumAlgorithm ChecksumAlgorithm { get; set; }

Property Value

ChecksumAlgorithm

Configuration

The replication configuration to be applied.

public ReplicationConfiguration Configuration { get; set; }

Property Value

ReplicationConfiguration

ExpectedBucketOwner

Gets and sets the property ExpectedBucketOwner.

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 

403 (Access Denied)
error. 
public string ExpectedBucketOwner { get; set; }

Property Value

string

Token

Gets and sets the property Token.

A token to allow Object Lock to be enabled for an existing bucket. 

public string Token { get; set; }

Property Value

string