Spectra Logic

1-800-833-1132 : 1-303-449-6400

Modify Amazon S3 Data Replication Rule

Description

Modify an Amazon S3 data replication rule for a data policy.

Note:

If the modify command does not include an optional request parameter, the replication rules retains the previous setting.

Requests

Syntax

PUT http[s]://{datapathDNSname}/_rest_/s3_data_replication_rule/{data replication rule UUID or other unique attribute}​[&initial_data_placement]
[&max_blob_part_size_in_bytes={64-bit integer}][replicate_deletes=TRUE|FALSE][&type=PERMANENT|RETIRED]

Request Parameters 

Parameter	Description	Required
initial_data_ placement	The storage class for any blobs transferred to the Amazon S3 instance. Values: § Standard - Provides high availability and performance for frequently accessed data. § Reduced Redundancy - Used for cheaper but less reliable storage. Not recommended for most scenarios. § Standard IA - (default) - Provides fast access to less frequently accessed data. § Glacier - Provides secure, long-term archive for rarely accessed data.	no
max_blob_part_ size_in_bytes	Specifies the maximum blob part size used when creating bulk PUT jobs. The maximum blob part size is 1 TB. Larger blob part sizes make public cloud workflows simpler, but may make it more difficult or impossible to reliably transmit blobs. Less reliable network connections to the public cloud require smaller blob part sizes. Values: Min: 100MB, Max: 1TB, Default: 1GB	no
replicate_deletes	Whether objects deleted from buckets are also deleted from the replication target. Values: TRUE (default) — Any delete received locally always replicates on the Azure target. If the local BlackPearl system cannot communicate with one or more targets, the delete fails. FALSE— Any deletes received locally do not replicate to the target.	no
type	The type of replication rule. Values: § PERMANENT — A copy of the data is replicated to the target. § RETIRED — A copy of already replicated data is maintained, but the rule is not applied to new data.	no

Responses

Response Elements

<Data>
   <DataPolicyId>{string}</DataPolicyId>
   <Id>{string}</Id>

   <InitialDataPlacement>
     STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|GLACIER
   </InitialDataPlacement>

   <MaxBlobPartSizeInBytes>

     {64-bit integer}
   </MaxBlobPartSizeInBytes>
   <ReplicateDeletes>TRUE|FALSE</ReplicateDeletes>
   <State>NORMAL</State>

   <TargetId>{string}</TargetId>
   <Type>PERMANENT|RETIRED</Type>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
DataPolicyId	The UUID for the data policy.
Id	The UUID for the Amazon S3 replication rule.
InitialData Placement	The storage class for any blobs transferred to the Amazon S3 instance. Values: Standard, Reduced Redundancy, Standard IA, Glacier. See initial_data_ placement for definitions.
MaxBlobSizeIn Bytes	The maximum blob size used when creating bulk PUT jobs. Default: 100 GB
ReplicateDeletes	Whether objects deleted from local buckets are also deleted from the replication target. Values: TRUE, FALSE
State	The state of the persistence rule. Value: NORMAL — The persistence rule is in a normal, included state.
TargetId	The UUID for the Amazon S3 target.
Type	The type of replication rule. Values: § PERMANENT — A copy of the data is replicated to the target. § RETIRED — A copy of already replicated data is maintained, but the rule is not applied to new data.

Example

Sample Request

This request retires the Amazon S3 replication rule with the UUID 4735bc7b-011b-49d8-84f9-b4bbac95d128.

POST http://blackpearl-hostname/_rest_/s3_data_replication_rule/4735bc7b-011b-49d8-84f9-b4bbac95d128?type=RETIRED HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <DataPolicyId>
      a3fbb966-0fe7-4202-bb58-029d6b4896ae
   </DataPolicyId>
   <Id>4735bc7b-011b-49d8-84f9-b4bbac95d128</Id>
   <InitialDataPlacement>STANDARD_IA</InitialDataPlacement>
   <MaxBlobPartSizeInBytes>1073741824</MaxBlobPartSizeInBytes>
   <ReplicateDeletes>TRUE</ReplicateDeletes>
   <State>NORMAL</State>
   <TargetId>5aa8dab6-4d27-4c01-a4eb-b003fade6012</TargetId>
   <Type>RETIRED</Type>
</Data>