Struct bonsaidb::keystorage::s3::aws_sdk_s3::operation::put_bucket_replication::builders::PutBucketReplicationFluentBuilder

pub struct PutBucketReplicationFluentBuilder { /* private fields */ }

Fluent builder constructing a request to PutBucketReplication.

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.

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.

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

The following operations are related to PutBucketReplication:

• GetBucketReplication

• DeleteBucketReplication

Implementations

impl PutBucketReplicationFluentBuilder

pub fn as_input(&self) -> &PutBucketReplicationInputBuilder

Access the PutBucketReplication as a reference.

pub async fn send( self ) -> impl Future<Output = Result<PutBucketReplicationOutput, SdkError<PutBucketReplicationError, Response<SdkBody>>>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub async fn customize( self ) -> impl Future<Output = Result<CustomizableOperation<PutBucketReplicationOutput, PutBucketReplicationError, PutBucketReplicationFluentBuilder>, SdkError<PutBucketReplicationError, Response>>>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn bucket( self, input: impl Into<String> ) -> PutBucketReplicationFluentBuilder

The name of the bucket

pub fn set_bucket( self, input: Option<String> ) -> PutBucketReplicationFluentBuilder

The name of the bucket

pub fn get_bucket(&self) -> &Option<String>

The name of the bucket

pub fn content_md5( self, input: impl Into<String> ) -> PutBucketReplicationFluentBuilder

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

pub fn set_content_md5( self, input: Option<String> ) -> PutBucketReplicationFluentBuilder

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

pub fn get_content_md5(&self) -> &Option<String>

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

pub fn checksum_algorithm( self, input: ChecksumAlgorithm ) -> PutBucketReplicationFluentBuilder

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

pub fn set_checksum_algorithm( self, input: Option<ChecksumAlgorithm> ) -> PutBucketReplicationFluentBuilder

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

pub fn get_checksum_algorithm(&self) -> &Option<ChecksumAlgorithm>

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

pub fn replication_configuration( self, input: ReplicationConfiguration ) -> PutBucketReplicationFluentBuilder

A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.

pub fn set_replication_configuration( self, input: Option<ReplicationConfiguration> ) -> PutBucketReplicationFluentBuilder

A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.

pub fn get_replication_configuration(&self) -> &Option<ReplicationConfiguration>

A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.

pub fn token( self, input: impl Into<String> ) -> PutBucketReplicationFluentBuilder

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

pub fn set_token( self, input: Option<String> ) -> PutBucketReplicationFluentBuilder

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

pub fn get_token(&self) -> &Option<String>

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

pub fn expected_bucket_owner( self, input: impl Into<String> ) -> PutBucketReplicationFluentBuilder

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

pub fn set_expected_bucket_owner( self, input: Option<String> ) -> PutBucketReplicationFluentBuilder

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

pub fn get_expected_bucket_owner(&self) -> &Option<String>

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Trait Implementations

impl Clone for PutBucketReplicationFluentBuilder

fn clone(&self) -> PutBucketReplicationFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PutBucketReplicationFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.