@@ -251,24 +251,111 @@ components:
251251 replication_config :
252252 type : object
253253 description : configuration object for custom replication
254+ explore_strategy :
255+ type : string
256+ description : defines the exploration strategy used for the replication job
257+ enum :
258+ - SIMPLE
259+ - TREE
260+ default : SIMPLE
261+ resources :
262+ type : object
263+ description : Lists replicated resources by status
264+ properties :
265+ succeeded :
266+ type : array
267+ items :
268+ type : string
269+ skipped :
270+ type : array
271+ items :
272+ type : string
273+ failed :
274+ type : array
275+ items :
276+ type : object
277+ properties :
278+ resource_identifier :
279+ type : string
280+ resource_type :
281+ type : string
282+ error :
283+ type : string
284+ root :
285+ type : object
286+ description : Present when the failed resource is a dependency
287+ of the root. Not present when the root itself failed.
288+ properties :
289+ resource_identifier :
290+ type : string
291+ resource_type :
292+ type : string
254293 ReplicationSupportedResource :
255294 additionalProperties : false
256295 type : object
296+ required :
297+ - resource_type
298+ - service
257299 properties :
258300 resource_type :
259301 type : string
260302 description : Type of resource
261- policy_statements :
262- type : array
263- description : Required IAM permissions to replicate resource.
264303 service :
265304 type : string
266305 description : AWS service.
267- identifier :
268- type : string
269- description : Resource property or properties used as identifier. In case
270- there are multiple properties, join them with ':'. ie. `RepositoryName:<ImageTag[Optional]>`
271- for ecr repository can be used as `my-repo` or `my-repo:latest`
306+ single :
307+ type : object
308+ description : Configuration items applicable to SINGLE_RESOURCE replication
309+ type
310+ properties :
311+ policy_statements :
312+ type : array
313+ description : Required IAM permissions to replicate resource.
314+ items :
315+ type : string
316+ identifier :
317+ type : string
318+ description : Resource property or properties used as identifier. In
319+ case there are multiple properties, join them with ':'. ie. `RepositoryName:<ImageTag[Optional]>`
320+ for ecr repository can be used as `my-repo` or `my-repo:latest`
321+ batch :
322+ type : object
323+ description : Configuration items applicable to BATCH replication type
324+ properties :
325+ policy_statements :
326+ type : array
327+ description : Required IAM permissions to replicate resource.
328+ items :
329+ type : string
330+ identifier :
331+ type : string
332+ description : Resource property or properties used as identifier. In
333+ case there are multiple properties, join them with ':'. ie. `RepositoryName:<ImageTag[Optional]>`
334+ for ecr repository can be used as `my-repo` or `my-repo:latest`
335+ resource_tree :
336+ type : object
337+ description : Configuration items applicable to TREE exploration strategy,
338+ when available
339+ properties :
340+ resources :
341+ type : array
342+ description : list of resources that will be replicated along with the
343+ resource or batch of resources replicated
344+ items :
345+ type : string
346+ extra_policy_statements :
347+ type : array
348+ description : Required IAM permissions to replicate the resources tree.
349+ This is in addition to what is required for the replication type (eg.
350+ SINGLE_RESOURCE, BATCH)
351+ items :
352+ type : string
353+ extra_config :
354+ type : object
355+ additionalProperties : true
356+ description : Used to expose extra configuration item when replicating a
357+ specific resource. Those are extra keys that can be sent in the `replication_job_config`
358+ object
272359 ReplicationConfigMock :
273360 type : object
274361 description : Mostly use for testing.
@@ -292,6 +379,20 @@ components:
292379 resource_identifier :
293380 type : string
294381 description : CloudControl identifier for resource.
382+ ReplicationConfigBatch :
383+ type : object
384+ description : Specify the AWS resource to replicate by providing `resource_type`.
385+ Most resources also require `resource_identifier`.
386+ required :
387+ - resource_type
388+ properties :
389+ resource_type :
390+ type : string
391+ description : ' Resource type in AWS CloudControl format. Example: AWS::IAM::Role'
392+ resource_identifier :
393+ type : string
394+ description : Usually a string or a json string. more details for each resources
395+ can be obtained by querying /_localstack/replicator/resources
295396 ReplicationRequest :
296397 additionalProperties : false
297398 type : object
@@ -345,9 +446,11 @@ components:
345446 type : string
346447 replication_job_config :
347448 description : Parameters for replication
449+ additionalProperties : true
348450 oneOf :
349451 - $ref : ' #/components/schemas/ReplicationConfigMock'
350452 - $ref : ' #/components/schemas/ReplicationConfigSingle'
453+ - $ref : ' #/components/schemas/ReplicationConfigBatch'
351454 NetworkEffectsConfig :
352455 type : object
353456 description : Configuration for network effects.
0 commit comments