Class PutBucketReplicationCommand

Example

Use a bare-bones client and the command you need to make an API call.

import { S3Client, PutBucketReplicationCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, PutBucketReplicationCommand } = require("ibm-cos-sdk-v2"); // CommonJS import
// import type { S3ClientConfig } from "ibm-cos-sdk-v2";
const config = {}; // type is S3ClientConfig
const client = new S3Client(config);
const input = { // PutBucketReplicationRequest
  Bucket: "STRING_VALUE", // required
  ContentMD5: "STRING_VALUE",
  ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256" || "CRC64NVME",
  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" || "FSX_OPENZFS" || "FSX_ONTAP",
          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);
// {};

Copy

Example: Set replication configuration on a bucket

// 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);
const response = await client.send(command);
/* response is
{ /* metadata only */ }
*/
Copy