Spectra Logic

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

Create Amazon S3 Data Replication Rule

Description

Create an Amazon S3 data replication rule for a data policy. Each Amazon S3 replication rule targets a specified AWS S3 instance (or a cloud provider instance that exposes an AWS S3 API) remote to the local BlackPearl system.

You cannot specify the same AWS S3 instance multiple times in different replication rules applied to the same data policy. You can reference the same AWS S3 instance across different data policies.

You must create the data policy and register the target AWS S3 instance before creating the replication rule. See Create Data Policy and Register Amazon S3 Target.

Requests

Syntax

POST http[s]://{datapathDNSname}/_rest_/s3_data_replication_rule​?data_policy_id={string}&target_id={string}​&type=PERMANENT [&initial_data_placement=STANDARD|REDUCED_REDUNDANCY|STANDARD_IA| GLACIER][&max_blob_part_size_in_bytes={64-bit integer}][&replicate_deletes=TRUE|FALSE]

Request Parameters 

Parameter	Description	Required
data_policy_id	Data policy name, UUID, or other unique attribute.	yes
target_id	Amazon S3 instance name, UUID, or other unique attribute.	yes
type	The type of replication rule to create. Value: PERMANENT Note: Replication rules can be modified to have a type of RETIRED, but cannot be created as RETIRED.	yes
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 the target, the delete fails. FALSE— Any deletes received locally do not replicate to the target.	no

Responses

Response Elements

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

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

   <MaxBlobPartSizeInBytes>

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

   <TargetId>{string}</TargetId>
   <Type>PERMANENT</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 data 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
Max Blob Size In 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 target Amazon S3 instance.
Type	The type of replication rule. Values: PERMANENT

Example

Sample Request

This request creates a permanent data replication rule for the data policy named “financedatapolicy” for the Amazon S3 instance with the target ID
“AWS-S3target1”.

POST http[s]://blackpearl-hostname/_rest_/s3_data_replication_rule​?data_policy_id=financedatapolicy&target_id=AWS-S3target1
&type=PERMANENT

Sample Response

HTTP/1.1 201 CREATED

<Data>

   <DataPolicyId>

     5d6fc2b5-169f-4863-8d7f-14e93dec01ec

   </DataPolicyId>

   <Id>dcba2d02-4f2c-4c9a-9b72-9c92fb9da36f</Id>

   <InitialDataPlacement>STANDARD_IA</InitialDataPlacement>

   <MaxBlobPartSizeInBytes>1073741824</MaxBlobPartSizeInBytes>
   <ReplicateDeletes>true</ReplicateDeletes>
   <State>NORMAL</State>

   <TargetId>a0d900bc-60d3-45ec-b6de-023d61a517c0</TargetId>

   <Type>PERMANENT</Type>

</Data>