Module Smaws_Client_RDS.RestoreDBInstanceFromDBSnapshot

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source's original configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.

If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot operation. RDS doesn't allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot operation. The result is that you replace the original DB instance with the DB instance created from the snapshot.

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

To restore from a DB snapshot with an unsupported engine version, you must first upgrade the engine version of the snapshot. For more information about upgrading a RDS for MySQL DB snapshot engine version, see Upgrading a MySQL DB snapshot engine version. For more information about upgrading a RDS for PostgreSQL DB snapshot engine version, Upgrading a PostgreSQL DB snapshot engine version.

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

val error_to_string : [ Smaws_Lib.Protocols.AwsQuery.error | `AuthorizationNotFoundFault of Types.authorization_not_found_fault | `BackupPolicyNotFoundFault of Types.backup_policy_not_found_fault | `CertificateNotFoundFault of Types.certificate_not_found_fault | `DBClusterSnapshotNotFoundFault of Types.db_cluster_snapshot_not_found_fault | `DBInstanceAlreadyExistsFault of Types.db_instance_already_exists_fault | `DBParameterGroupNotFoundFault of Types.db_parameter_group_not_found_fault | `DBSecurityGroupNotFoundFault of Types.db_security_group_not_found_fault | `DBSnapshotNotFoundFault of Types.db_snapshot_not_found_fault | `DBSubnetGroupDoesNotCoverEnoughAZs of Types.db_subnet_group_does_not_cover_enough_a_zs | `DBSubnetGroupNotFoundFault of Types.db_subnet_group_not_found_fault | `DomainNotFoundFault of Types.domain_not_found_fault | `InstanceQuotaExceededFault of Types.instance_quota_exceeded_fault | `InsufficientDBInstanceCapacityFault of Types.insufficient_db_instance_capacity_fault | `InvalidDBSnapshotStateFault of Types.invalid_db_snapshot_state_fault | `InvalidRestoreFault of Types.invalid_restore_fault | `InvalidSubnet of Types.invalid_subnet | `InvalidVPCNetworkStateFault of Types.invalid_vpc_network_state_fault | `KMSKeyNotAccessibleFault of Types.kms_key_not_accessible_fault | `NetworkTypeNotSupported of Types.network_type_not_supported | `OptionGroupNotFoundFault of Types.option_group_not_found_fault | `ProvisionedIopsNotAvailableInAZFault of Types.provisioned_iops_not_available_in_az_fault | `StorageQuotaExceededFault of Types.storage_quota_exceeded_fault | `StorageTypeNotSupportedFault of Types.storage_type_not_supported_fault | `TenantDatabaseQuotaExceededFault of Types.tenant_database_quota_exceeded_fault | `VpcEncryptionControlViolationException of Types.vpc_encryption_control_violation_exception ] -> string
val request : 'http_type Smaws_Lib.Context.t -> Types.restore_db_instance_from_db_snapshot_message -> (Types.restore_db_instance_from_db_snapshot_result, [> Smaws_Lib.Protocols.AwsQuery.error | `AuthorizationNotFoundFault of Types.authorization_not_found_fault | `BackupPolicyNotFoundFault of Types.backup_policy_not_found_fault | `CertificateNotFoundFault of Types.certificate_not_found_fault | `DBClusterSnapshotNotFoundFault of Types.db_cluster_snapshot_not_found_fault | `DBInstanceAlreadyExistsFault of Types.db_instance_already_exists_fault | `DBParameterGroupNotFoundFault of Types.db_parameter_group_not_found_fault | `DBSecurityGroupNotFoundFault of Types.db_security_group_not_found_fault | `DBSnapshotNotFoundFault of Types.db_snapshot_not_found_fault | `DBSubnetGroupDoesNotCoverEnoughAZs of Types.db_subnet_group_does_not_cover_enough_a_zs | `DBSubnetGroupNotFoundFault of Types.db_subnet_group_not_found_fault | `DomainNotFoundFault of Types.domain_not_found_fault | `InstanceQuotaExceededFault of Types.instance_quota_exceeded_fault | `InsufficientDBInstanceCapacityFault of Types.insufficient_db_instance_capacity_fault | `InvalidDBSnapshotStateFault of Types.invalid_db_snapshot_state_fault | `InvalidRestoreFault of Types.invalid_restore_fault | `InvalidSubnet of Types.invalid_subnet | `InvalidVPCNetworkStateFault of Types.invalid_vpc_network_state_fault | `KMSKeyNotAccessibleFault of Types.kms_key_not_accessible_fault | `NetworkTypeNotSupported of Types.network_type_not_supported | `OptionGroupNotFoundFault of Types.option_group_not_found_fault | `ProvisionedIopsNotAvailableInAZFault of Types.provisioned_iops_not_available_in_az_fault | `StorageQuotaExceededFault of Types.storage_quota_exceeded_fault | `StorageTypeNotSupportedFault of Types.storage_type_not_supported_fault | `TenantDatabaseQuotaExceededFault of Types.tenant_database_quota_exceeded_fault | `VpcEncryptionControlViolationException of Types.vpc_encryption_control_violation_exception ]) Stdlib.result
val request_with_metadata : 'http_type Smaws_Lib.Context.t -> Types.restore_db_instance_from_db_snapshot_message -> (Types.restore_db_instance_from_db_snapshot_result Smaws_Lib.Response.t, [> Smaws_Lib.Protocols.AwsQuery.error | `AuthorizationNotFoundFault of Types.authorization_not_found_fault | `BackupPolicyNotFoundFault of Types.backup_policy_not_found_fault | `CertificateNotFoundFault of Types.certificate_not_found_fault | `DBClusterSnapshotNotFoundFault of Types.db_cluster_snapshot_not_found_fault | `DBInstanceAlreadyExistsFault of Types.db_instance_already_exists_fault | `DBParameterGroupNotFoundFault of Types.db_parameter_group_not_found_fault | `DBSecurityGroupNotFoundFault of Types.db_security_group_not_found_fault | `DBSnapshotNotFoundFault of Types.db_snapshot_not_found_fault | `DBSubnetGroupDoesNotCoverEnoughAZs of Types.db_subnet_group_does_not_cover_enough_a_zs | `DBSubnetGroupNotFoundFault of Types.db_subnet_group_not_found_fault | `DomainNotFoundFault of Types.domain_not_found_fault | `InstanceQuotaExceededFault of Types.instance_quota_exceeded_fault | `InsufficientDBInstanceCapacityFault of Types.insufficient_db_instance_capacity_fault | `InvalidDBSnapshotStateFault of Types.invalid_db_snapshot_state_fault | `InvalidRestoreFault of Types.invalid_restore_fault | `InvalidSubnet of Types.invalid_subnet | `InvalidVPCNetworkStateFault of Types.invalid_vpc_network_state_fault | `KMSKeyNotAccessibleFault of Types.kms_key_not_accessible_fault | `NetworkTypeNotSupported of Types.network_type_not_supported | `OptionGroupNotFoundFault of Types.option_group_not_found_fault | `ProvisionedIopsNotAvailableInAZFault of Types.provisioned_iops_not_available_in_az_fault | `StorageQuotaExceededFault of Types.storage_quota_exceeded_fault | `StorageTypeNotSupportedFault of Types.storage_type_not_supported_fault | `TenantDatabaseQuotaExceededFault of Types.tenant_database_quota_exceeded_fault | `VpcEncryptionControlViolationException of Types.vpc_encryption_control_violation_exception ] * Smaws_Lib.Response.metadata) Stdlib.result