Skip to main content

Trigger AWS Assembly Config Only Recovery​

API to trigger AWS Assembly Config Only Recovery.

  • This action will recover configuration-only resources and will exclude data resources.
  • By default Config recovery supports only rebuild recovery mode.
Path Parameters
  • accountId int64 required

    Cloud Rewind account ID.

  • projectId string required

    Cloud Rewind project ID.

  • assemblyId int64 required

    AWS cloud assembly ID.

Request Body required
  • recoveryName string required

    Possible values: >= 3 and <= 55, Value must match regular expression ^[a-z]([a-z0-9-]*[a-z0-9])?

    Name of the recovery

  • recoveryScope string required

    Possible values: [same-region, cross-region, cross-account]

    Defines the boundary within which the AWS config resource recovery should occur.

    ValueDescription
    same-regionRecovery within the same region
    cross-regionRecovery across different region
    cross-accountRecovery across different account
  • crossRegionConfiguration object

    Configuration for cross-region resource recovery, required if cross-region recovery scope is used.

  • recoveryRegion string

    Possible values: [us-east-1, us-east-2, us-west-1, us-west-2, ap-south-1, ap-south-2, ap-northeast-3, ap-northeast-2, ap-northeast-1, ap-southeast-1, ap-southeast-2, ap-southeast-3, ca-central-1, eu-central-1, eu-central-2, eu-west-1, eu-west-2, eu-west-3, eu-north-1, sa-east-1, af-south-1, ap-east-1, eu-south-1, eu-south-2, me-central-1, me-south-1, il-central-1]

    Region where the recovery will take place

  • crossAccountConfiguration object

    Configuration for Cross Account resource recovery, required if cross-account recovery scope is used.

  • recoveryRegion string

    Possible values: [us-east-1, us-east-2, us-west-1, us-west-2, ap-south-1, ap-south-2, ap-northeast-3, ap-northeast-2, ap-northeast-1, ap-southeast-1, ap-southeast-2, ap-southeast-3, ca-central-1, eu-central-1, eu-central-2, eu-west-1, eu-west-2, eu-west-3, eu-north-1, sa-east-1, af-south-1, ap-east-1, eu-south-1, eu-south-2, me-central-1, me-south-1, il-central-1]

    Region where the cross account recovery will take place

  • cloudConnectionId int64

    ID of the cloud connection for cross account recovery

  • newNetworkConfiguration object

    Configuration for new network recovery, required if rebuild recovery mode is used.

  • zoneMapping object

    Enables resource recovery across Availability Zones using a new network configuration through zone mapping. This configuration is applicable only for same-region recovery scenarios.
    Format: {"source-zone": "target-zone"}.

  • property name* string
  • disableInboundTraffic boolean

    This configuration blocks inbound traffic for the new network setup

  • disableOutboundTraffic boolean

    This configuration blocks outbound traffic for the new network setup

  • extendedConfigurations object

    Enables extended settings to support advanced resource recovery operations

  • enableSshKeyImport boolean

    Enable SSH key import for the recovery resources

  • scheduleResetConfiguration object

    Optional schedule reset configuration for the auto recovery reset

  • resetFrequency string

    Possible values: [hours, days]

    Frequency at which the recovery reset should be scheduled.

    ValueDescription
    hoursResets the recovery in hours
    daysResets the recovery in days
  • resetInterval int32

    Number representing the reset interval, e.g., '2 hours', '2 days'

Responses

Created

Schema
  • recoveryId string

    ID of the initiated recovery operation

Loading...