Skip to main content

Restore an RDS resource​

Restores the specified RDS resource backup or snapshot to the specified target destination.

Query Parameters
  • embed string

    Embeds the details of each associated resource. Set the parameter to one of the following embeddable links to include additional details associated with the resource.

    Embeddable LinkDescription
    read-taskEmbeds the associated task in the response. For example, ?embed=read-task
    For more information about embedded links, refer to the Embedding Referenced Resources section of this guide.
Request Body required
  • source object required

    The RDS resource backup or snapshot to be restored. Only one of these fields should be set.

  • backup object

    The parameters for initiating an RDS restore from a backup.

  • backup_id string required

    The Clumio-assigned ID of the RDS backup to be restored. Use the GET /backups/aws/rds-resources endpoint to fetch valid values.

  • snapshot object

    The parameters for initiating an RDS restore from a snapshot.

  • resource_id string required

    The Clumio-assigned ID of the RDS resource to be restored. Use the GET /datasources/aws/rds-resources endpoint to fetch valid values.

  • timestamp string required

    A point in time to be restored in RFC-3339 format.

  • target object required

    The configuration of the RDS resource to be restored.

  • environment_id string

    The Clumio-assigned ID of the AWS environment to be used as the restore destination. Use the GET /datasources/aws/environments endpoint to fetch valid values.

  • instance_class string

    The instance class of the RDS resources to be created. Possible values include db.r5.2xlarge and db.t2.small.

  • is_publicly_accessible boolean

    Designates whether the restored RDS resource also has a public IP address in addition to the private IP address.

  • kms_key_native_id string

    The AWS-assigned ID of the KMS encryption key used to encrypt data in this RDS resource.

  • name string required

    The name given to the restored RDS resource. The name must follow AWS RDS naming conventions: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints

  • option_group_name string

    Option group name to be added to the restored RDS resource

  • security_group_native_ids string[]

    The AWS-assigned IDs of the security groups to be associated with the restored RDS resource.

  • subnet_group_name string

    The AWS-assigned name of the subnet group to be associated with the restored RDS resource.

  • tags object[]

    The AWS tags to be applied to the restored instance.

  • key string required

    The AWS-assigned tag key.

  • value string

    The AWS-assigned tag value.

Responses

Success

Schema
  • _embedded object

    Embedded responses related to the resource.

  • read-task Embeds the associated task of a resource in the response if requested using the `embed` query parameter.

    Embeds the associated task of a resource in the response if requested using the embed query parameter.

  • _links object

    URLs to pages related to the resource.

  • _self object

    The HATEOAS link to this resource.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • read-task object

    A HATEOAS link to the task associated with this resource.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • task_id string

    The Clumio-assigned ID of the task created by this restore request. The progress of the task can be monitored using the GET /tasks/{task_id} endpoint.

Loading...