@aws-sdk/client-s3
Version:
AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native
235 lines (234 loc) • 11.7 kB
TypeScript
import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
import { PutBucketReplicationRequest } from "../models/models_1";
import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
/**
* @public
*/
export type { __MetadataBearer };
export { $Command };
/**
* @public
*
* The input for {@link PutBucketReplicationCommand}.
*/
export interface PutBucketReplicationCommandInput extends PutBucketReplicationRequest {
}
/**
* @public
*
* The output of {@link PutBucketReplicationCommand}.
*/
export interface PutBucketReplicationCommandOutput extends __MetadataBearer {
}
declare const PutBucketReplicationCommand_base: {
new (input: PutBucketReplicationCommandInput): import("@smithy/smithy-client").CommandImpl<PutBucketReplicationCommandInput, PutBucketReplicationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
new (__0_0: PutBucketReplicationCommandInput): import("@smithy/smithy-client").CommandImpl<PutBucketReplicationCommandInput, PutBucketReplicationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
* <note>
* <p>This operation is not supported by directory buckets.</p>
* </note>
* <p> Creates a replication configuration or replaces an existing one. For more information,
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html">Replication</a> in the <i>Amazon S3 User Guide</i>. </p>
* <p>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
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requestedregion">
* <code>aws:RequestedRegion</code>
* </a> condition key.</p>
* <p>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.</p>
* <p>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:
* <code>DeleteMarkerReplication</code>, <code>Status</code>, and
* <code>Priority</code>.</p>
* <note>
* <p>If you are using an earlier version of the replication configuration, Amazon S3 handles
* replication of delete markers differently. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations">Backward Compatibility</a>.</p>
* </note>
* <p>For information about enabling versioning on a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html">Using Versioning</a>.</p>
* <dl>
* <dt>Handling Replication of Encrypted Objects</dt>
* <dd>
* <p>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: <code>SourceSelectionCriteria</code>,
* <code>SseKmsEncryptedObjects</code>, <code>Status</code>,
* <code>EncryptionConfiguration</code>, and <code>ReplicaKmsKeyID</code>. For
* information about replication configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html">Replicating
* Objects Created with SSE Using KMS keys</a>.</p>
* <p>For information on <code>PutBucketReplication</code> errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList">List of
* replication-related error codes</a>
* </p>
* </dd>
* <dt>Permissions</dt>
* <dd>
* <p>To create a <code>PutBucketReplication</code> request, you must have
* <code>s3:PutReplicationConfiguration</code> permissions for the bucket.
*
* </p>
* <p>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
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in
* a Policy</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access
* Permissions to Your Amazon S3 Resources</a>.</p>
* <note>
* <p>To perform this operation, the user or role performing the action must have
* the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html">iam:PassRole</a>
* permission.</p>
* </note>
* </dd>
* </dl>
* <p>The following operations are related to <code>PutBucketReplication</code>:</p>
* <ul>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html">GetBucketReplication</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html">DeleteBucketReplication</a>
* </p>
* </li>
* </ul>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { S3Client, PutBucketReplicationCommand } from "@aws-sdk/client-s3"; // ES Modules import
* // const { S3Client, PutBucketReplicationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
* const client = new S3Client(config);
* const input = { // PutBucketReplicationRequest
* Bucket: "STRING_VALUE", // required
* ContentMD5: "STRING_VALUE",
* ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256",
* ReplicationConfiguration: { // ReplicationConfiguration
* Role: "STRING_VALUE", // required
* Rules: [ // ReplicationRules // required
* { // ReplicationRule
* ID: "STRING_VALUE",
* Priority: Number("int"),
* Prefix: "STRING_VALUE",
* Filter: { // ReplicationRuleFilter
* Prefix: "STRING_VALUE",
* Tag: { // Tag
* Key: "STRING_VALUE", // required
* Value: "STRING_VALUE", // required
* },
* And: { // ReplicationRuleAndOperator
* Prefix: "STRING_VALUE",
* Tags: [ // TagSet
* {
* Key: "STRING_VALUE", // required
* Value: "STRING_VALUE", // required
* },
* ],
* },
* },
* Status: "Enabled" || "Disabled", // required
* SourceSelectionCriteria: { // SourceSelectionCriteria
* SseKmsEncryptedObjects: { // SseKmsEncryptedObjects
* Status: "Enabled" || "Disabled", // required
* },
* ReplicaModifications: { // ReplicaModifications
* Status: "Enabled" || "Disabled", // required
* },
* },
* ExistingObjectReplication: { // ExistingObjectReplication
* Status: "Enabled" || "Disabled", // required
* },
* Destination: { // Destination
* Bucket: "STRING_VALUE", // required
* Account: "STRING_VALUE",
* StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "GLACIER" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_IR" || "SNOW" || "EXPRESS_ONEZONE",
* AccessControlTranslation: { // AccessControlTranslation
* Owner: "Destination", // required
* },
* EncryptionConfiguration: { // EncryptionConfiguration
* ReplicaKmsKeyID: "STRING_VALUE",
* },
* ReplicationTime: { // ReplicationTime
* Status: "Enabled" || "Disabled", // required
* Time: { // ReplicationTimeValue
* Minutes: Number("int"),
* },
* },
* Metrics: { // Metrics
* Status: "Enabled" || "Disabled", // required
* EventThreshold: {
* Minutes: Number("int"),
* },
* },
* },
* DeleteMarkerReplication: { // DeleteMarkerReplication
* Status: "Enabled" || "Disabled",
* },
* },
* ],
* },
* Token: "STRING_VALUE",
* ExpectedBucketOwner: "STRING_VALUE",
* };
* const command = new PutBucketReplicationCommand(input);
* const response = await client.send(command);
* // {};
*
* ```
*
* @param PutBucketReplicationCommandInput - {@link PutBucketReplicationCommandInput}
* @returns {@link PutBucketReplicationCommandOutput}
* @see {@link PutBucketReplicationCommandInput} for command's `input` shape.
* @see {@link PutBucketReplicationCommandOutput} for command's `response` shape.
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
*
* @throws {@link S3ServiceException}
* <p>Base exception class for all service exceptions from S3 service.</p>
*
* @public
* @example Set replication configuration on a bucket
* ```javascript
* // The following example sets replication configuration on a bucket.
* const input = {
* "Bucket": "examplebucket",
* "ReplicationConfiguration": {
* "Role": "arn:aws:iam::123456789012:role/examplerole",
* "Rules": [
* {
* "Destination": {
* "Bucket": "arn:aws:s3:::destinationbucket",
* "StorageClass": "STANDARD"
* },
* "Prefix": "",
* "Status": "Enabled"
* }
* ]
* }
* };
* const command = new PutBucketReplicationCommand(input);
* await client.send(command);
* // example id: id-1
* ```
*
*/
export declare class PutBucketReplicationCommand extends PutBucketReplicationCommand_base {
/** @internal type navigation helper, not in runtime. */
protected static __types: {
api: {
input: PutBucketReplicationRequest;
output: {};
};
sdk: {
input: PutBucketReplicationCommandInput;
output: PutBucketReplicationCommandOutput;
};
};
}