restore_from_db_backup
async
¶
restore_from_db_backup(
name: DbResourceName,
db_backup_id: DbBackupId,
*,
config_overrides: Optional[AsyncTimestreamInfluxDBClientConfig] = None,
restore_to_time: Optional[datetime] = None,
restore_mode: Optional[RestoreMode] = None,
vpc_subnet_ids: Optional[VpcSubnetIdList] = None,
vpc_security_group_ids: Optional[VpcSecurityGroupIdList] = None,
publicly_accessible: Optional[bool] = None,
log_delivery_configuration: Optional[LogDeliveryConfiguration] = None,
maintenance_schedule: Optional[MaintenanceSchedule] = None,
tags: Optional[RequestTagMap] = None,
port: Optional[Port] = None,
network_type: Optional[NetworkType] = None,
deployment_type: Optional[ResourceDeploymentType] = None,
db_backup_configurations: Optional[DbBackupConfigurationInputList] = None,
kms_key_id: Optional[KmsKeyId] = None,
) -> RestoreFromDbBackupOutput
Restores a Timestream for InfluxDB resource from a backup. By default, a new resource is created. You can optionally restore to the same resource using the REPLACE_EXISTING restore mode.
Parameters:
-
name(DbResourceName) –The name of the new resource to create from the restore. If restoring to an existing resource, the name must match the existing resource name.
-
db_backup_id(DbBackupId) –The identifier of the backup to restore from.
-
restore_to_time(Optional[datetime], default:None) –The point in time to restore to, for continuous backups. Must be within the backup's retention window.
-
restore_mode(Optional[RestoreMode], default:None) –Specifies whether to restore to a new resource or replace the existing resource. Valid values are NEW_RESOURCE (default) and REPLACE_EXISTING.
-
vpc_subnet_ids(Optional[VpcSubnetIdList], default:None) –A list of VPC subnet IDs for the restored resource. If not specified, the restored resource uses the same subnets as the backup.
-
vpc_security_group_ids(Optional[VpcSecurityGroupIdList], default:None) –A list of VPC security group IDs for the restored resource. If not specified, the restored resource uses the same security groups as the backup.
-
publicly_accessible(Optional[bool], default:None) –Specifies whether the restored resource is publicly accessible.
-
log_delivery_configuration(Optional[LogDeliveryConfiguration], default:None) –Configuration for sending InfluxDB engine logs to the specified S3 bucket for the restored resource.
-
maintenance_schedule(Optional[MaintenanceSchedule], default:None) –The maintenance schedule for the restored resource.
-
tags(Optional[RequestTagMap], default:None) –A list of key-value pairs to associate with the restored resource.
-
port(Optional[Port], default:None) –The port number on which the restored InfluxDB resource accepts connections.
-
network_type(Optional[NetworkType], default:None) –Specifies the network type of the restored resource. Valid values are IPV4 and DUAL.
-
deployment_type(Optional[ResourceDeploymentType], default:None) –Specifies the deployment type of the restored resource. Valid values are SINGLE_AZ, WITH_MULTIAZ_STANDBY, and MULTI_NODE_READ_REPLICAS.
-
db_backup_configurations(Optional[DbBackupConfigurationInputList], default:None) –A list of backup configurations to apply to the restored resource.
-
kms_key_id(Optional[KmsKeyId], default:None) –The Amazon Web Services KMS key identifier to use for encryption of the restored resource. Can be a key ID, key ARN, alias name, or alias ARN.
Raises:
-
AccessDeniedException–You do not have sufficient access to perform this action.
-
ConflictException–The request conflicts with an existing resource in Timestream for InfluxDB.
-
InternalServerException–The request processing has failed because of an unknown error, exception or failure.
-
ResourceNotFoundException–The requested resource was not found or does not exist.
-
ServiceQuotaExceededException–The request exceeds the service quota.
-
ThrottlingException–The request was denied due to request throttling.
-
ValidationException–The input fails to satisfy the constraints specified by Timestream for InfluxDB.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_timestream_influxdb/_services/async_timestream_influx_db.py
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 | |