Skip to main content

AWS Recovery Details​

API to get AWS recovery details

Path Parameters
  • accountId int64 required

    Cloud Rewind account ID.

  • projectId string required

    Cloud Rewind project ID.

  • assemblyId int64 required

    AWS cloud assembly ID.

Query Parameters
  • id string required

    AWS Recovery ID

Responses

OK

Schema
  • id string

    Id of the recovery

  • recoveryName string

    Name of the recovery

  • recoveryScope string

    Defines the boundary within which the AWS resource recovery had happened.

  • recoveryMode string

    Specifies how resources were handled during the recovery process.

  • recoveryStatus string

    Possible values: [pending, in-progress, aborted, partially-completed, completed, failed]

    Status of the recovery process.

    ValueDescription
    pendingThe recovery process is in draft or pending state.
    in-progressThe recovery or deployment is currently in progress.
    abortedThe recovery process was aborted.
    partially-completedThe recovery completed partially; some resources may not be fully recovered.
    completedThe recovery process completed successfully.
    failedThe recovery process has failed.
  • recoveryStartTime date-time

    The start time of the recovery operation

  • recoveryEndTime date-time

    The end time of the recovery operation

  • recoveryDuration int64

    The duration of the recovery operation in milliseconds

  • recoveryErrorMessage string

    Message contains the recovery failure reasons if the recovery operation fails

  • resetStatus string

    Possible values: [pending, in-progress, stalled, completed, failed]

    Status of the reset operation.

    ValueDescription
    pendingThe reset operation is pending and has not started yet.
    in-progressThe reset operation is currently in progress.
    stalledThe reset operation is stalled (reset is not allowed if any restore is running on the timeline).
    completedThe reset operation completed successfully.
    failedThe reset operation failed or the pre-reset web hook failed.
  • resetStartTime date-time

    The start time of the recovery reset operation

  • resetEndTime date-time

    The end time of the recovery reset operation

  • resetDuration int64

    The duration of the recovery reset operation in milliseconds

  • resetErrorMessage string

    Message contains the reset failure reasons if the reset operation fails

  • resourceFilterStrategy object

    Resource filter strategy used for filtering resources during the recovery process.

  • type string

    Possible values: [all, custom, tags]

    Type of resource filter strategy.

    ValueDescription
    allInclude all the protected resources for recovery
    customFilter resources based on a custom resource filter
    tagsFilter resources based on matching resource tags
  • tagFilter object

    Defines the tag filter for tags based resource filtering.

  • tagFilterCondition string

    Possible values: [match-all-tags, match-any-tags]

    Condition to apply between the resource tags for tags based resource filtering.

    ValueDescription
    match-all-tagsMatch resources that must have all specified tags
    match-any-tagsMatch resources that have any of the specified tags
  • tags object[]

    List of tags to filter resources

  • key string

    Key of the tag

  • value string

    Value of the tag

  • resourceFilter object

    Defines the resource filter for manual based resource filtering.

  • resources string[]

    IDs of the cloud resources for recovery

  • 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

  • crossZoneConfiguration object

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

  • subnetMapping object

    Maps a source subnet to a target subnet to enable resource recovery across different availability zones.
    Format: {"source-subnet": "target-subnet"}.

  • property name* string
  • existingNetworkConfiguration object

    Configuration for existing network recovery, required if reuse-existing recovery mode is used.

  • vpcId string

    ID of the VPC where the existing network resources are located

  • subnetMapping object

    Maps a source subnet to a target subnet to enable resource recovery across different availability zones.
    Format: {"source-subnet": "target-subnet"}.

  • property name* string
  • ipAddressAllocationType string

    Possible values: [default, dhcp]

    Type of IP address allocation for AWS resources during recovery.

    ValueDescription
    defaultAllocates the same source IP address to the recovery resource.
    If the source IP is unavailable, a new IP address will be assigned.
    dhcpAllocate a new IP address for the recovery resource.
  • 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

  • useExistingLoadBalancer boolean

    Attaches the recovery resource to an already recovered load balancer. This option is applicable only for reuse-existing and use-source recovery scenarios.

  • updateDnsRecords boolean

    Update the existing DNS Records associated with the recovery resources configuration

  • enableSshKeyImport boolean

    Enable SSH key import for the recovery resources

  • skipRecoveredResourceAutoProtection boolean

    Enable to skip auto-protection for recovered 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'

  • webhookDetails object[]

    Recovery webhook configuration for the recovery.

  • url string

    URL to which the webhook will send notifications

  • webhookType string

    Type of the webhook

  • status string

    Status of the webhook trigger

  • httpMethod string

    HTTP method used for the webhook

  • httpStatusCode int32

    HTTP status code received from the webhook trigger

  • timeout int32

    Timeout duration for the webhook trigger

  • errorMessage string

    Message containing the error details if the webhook trigger fails

Loading...