Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.S3.PutBucketReplication

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

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.

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:

Synopsis

Creating a Request

data PutBucketReplication Source #

See: newPutBucketReplication smart constructor.

Constructors

PutBucketReplication'

Fields

checksumAlgorithm :: Maybe 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.
contentMD5 :: Maybe Text
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.
expectedBucketOwner :: Maybe Text
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).
token :: Maybe Text
A token to allow Object Lock to be enabled for an existing bucket.
bucket :: BucketName
The name of the bucket
replicationConfiguration :: ReplicationConfiguration

Instances

Instances details

ToHeaders PutBucketReplication Source #
Instance details Defined in Amazonka.S3.PutBucketReplication Methods toHeaders :: PutBucketReplication -> [Header] #
ToPath PutBucketReplication Source #
Instance details Defined in Amazonka.S3.PutBucketReplication Methods toPath :: PutBucketReplication -> ByteString #
ToQuery PutBucketReplication Source #
Instance details Defined in Amazonka.S3.PutBucketReplication Methods toQuery :: PutBucketReplication -> QueryString #
ToElement PutBucketReplication Source #
Instance details Defined in Amazonka.S3.PutBucketReplication Methods toElement :: PutBucketReplication -> Element #
AWSRequest PutBucketReplication Source #
Instance details Defined in Amazonka.S3.PutBucketReplication Associated Types type AWSResponse PutBucketReplication # Methods request :: (Service -> Service) -> PutBucketReplication -> Request PutBucketReplication # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutBucketReplication -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutBucketReplication))) #
Generic PutBucketReplication Source #
Instance details Defined in Amazonka.S3.PutBucketReplication Associated Types type Rep PutBucketReplication :: Type -> Type # Methods from :: PutBucketReplication -> Rep PutBucketReplication x # to :: Rep PutBucketReplication x -> PutBucketReplication #
Read PutBucketReplication Source #
Instance details Defined in Amazonka.S3.PutBucketReplication Methods readsPrec :: Int -> ReadS PutBucketReplication # readList :: ReadS [PutBucketReplication] # readPrec :: ReadPrec PutBucketReplication # readListPrec :: ReadPrec [PutBucketReplication] #
Show PutBucketReplication Source #
Instance details Defined in Amazonka.S3.PutBucketReplication Methods showsPrec :: Int -> PutBucketReplication -> ShowS # show :: PutBucketReplication -> String # showList :: [PutBucketReplication] -> ShowS #
NFData PutBucketReplication Source #
Instance details Defined in Amazonka.S3.PutBucketReplication Methods rnf :: PutBucketReplication -> () #
Eq PutBucketReplication Source #
Instance details Defined in Amazonka.S3.PutBucketReplication Methods (==) :: PutBucketReplication -> PutBucketReplication -> Bool # (/=) :: PutBucketReplication -> PutBucketReplication -> Bool #
Hashable PutBucketReplication Source #
Instance details Defined in Amazonka.S3.PutBucketReplication Methods hashWithSalt :: Int -> PutBucketReplication -> Int # hash :: PutBucketReplication -> Int #
type AWSResponse PutBucketReplication Source #
Instance details Defined in Amazonka.S3.PutBucketReplication type AWSResponse PutBucketReplication = PutBucketReplicationResponse
type Rep PutBucketReplication Source #
Instance details Defined in Amazonka.S3.PutBucketReplication type Rep PutBucketReplication = D1 ('MetaData "PutBucketReplication" "Amazonka.S3.PutBucketReplication" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "PutBucketReplication'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "checksumAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChecksumAlgorithm)) :: (S1 ('MetaSel ('Just "contentMD5") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "expectedBucketOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BucketName) :*: S1 ('MetaSel ('Just "replicationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ReplicationConfiguration)))))

newPutBucketReplication Source #

Arguments

:: BucketName	`PutBucketReplication`
-> ReplicationConfiguration	`$sel:replicationConfiguration:PutBucketReplication'`
-> PutBucketReplication

Create a value of PutBucketReplication with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

PutBucketReplication, putBucketReplication_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.

$sel:contentMD5:PutBucketReplication', putBucketReplication_contentMD5 - 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.

$sel:expectedBucketOwner:PutBucketReplication', putBucketReplication_expectedBucketOwner - 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).

$sel:token:PutBucketReplication', putBucketReplication_token - A token to allow Object Lock to be enabled for an existing bucket.

PutBucketReplication, putBucketReplication_bucket - The name of the bucket

$sel:replicationConfiguration:PutBucketReplication', putBucketReplication_replicationConfiguration - Undocumented member.

Request Lenses

putBucketReplication_checksumAlgorithm :: Lens' PutBucketReplication (Maybe ChecksumAlgorithm) Source #

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.

putBucketReplication_contentMD5 :: Lens' PutBucketReplication (Maybe Text) Source #

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.

putBucketReplication_expectedBucketOwner :: Lens' PutBucketReplication (Maybe Text) Source #

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

putBucketReplication_token :: Lens' PutBucketReplication (Maybe Text) Source #

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

putBucketReplication_bucket :: Lens' PutBucketReplication BucketName Source #

The name of the bucket

putBucketReplication_replicationConfiguration :: Lens' PutBucketReplication ReplicationConfiguration Source #

Undocumented member.

Destructuring the Response

data PutBucketReplicationResponse Source #

See: newPutBucketReplicationResponse smart constructor.

Constructors

PutBucketReplicationResponse'

Instances

Instances details

Generic PutBucketReplicationResponse Source #
Instance details Defined in Amazonka.S3.PutBucketReplication Associated Types type Rep PutBucketReplicationResponse :: Type -> Type # Methods from :: PutBucketReplicationResponse -> Rep PutBucketReplicationResponse x # to :: Rep PutBucketReplicationResponse x -> PutBucketReplicationResponse #
Read PutBucketReplicationResponse Source #
Instance details Defined in Amazonka.S3.PutBucketReplication Methods readsPrec :: Int -> ReadS PutBucketReplicationResponse # readList :: ReadS [PutBucketReplicationResponse] # readPrec :: ReadPrec PutBucketReplicationResponse # readListPrec :: ReadPrec [PutBucketReplicationResponse] #
Show PutBucketReplicationResponse Source #
Instance details Defined in Amazonka.S3.PutBucketReplication Methods showsPrec :: Int -> PutBucketReplicationResponse -> ShowS # show :: PutBucketReplicationResponse -> String # showList :: [PutBucketReplicationResponse] -> ShowS #
NFData PutBucketReplicationResponse Source #
Instance details Defined in Amazonka.S3.PutBucketReplication Methods rnf :: PutBucketReplicationResponse -> () #
Eq PutBucketReplicationResponse Source #
Instance details Defined in Amazonka.S3.PutBucketReplication Methods (==) :: PutBucketReplicationResponse -> PutBucketReplicationResponse -> Bool # (/=) :: PutBucketReplicationResponse -> PutBucketReplicationResponse -> Bool #
type Rep PutBucketReplicationResponse Source #
Instance details Defined in Amazonka.S3.PutBucketReplication type Rep PutBucketReplicationResponse = D1 ('MetaData "PutBucketReplicationResponse" "Amazonka.S3.PutBucketReplication" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "PutBucketReplicationResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPutBucketReplicationResponse :: PutBucketReplicationResponse Source #

Create a value of PutBucketReplicationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.